Skip to content

Commit

Permalink
feat(docs): update schema.json + mkdocs cli pages
Browse files Browse the repository at this point in the history
  • Loading branch information
LGUG2Z committed Apr 4, 2024
1 parent c05e9ea commit f2c4dad
Show file tree
Hide file tree
Showing 13 changed files with 497 additions and 185 deletions.
2 changes: 1 addition & 1 deletion docs/cli/float-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe float-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/identify-border-overflow-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe identify-border-overflow-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/identify-layered-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/identify-object-name-change-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/identify-tray-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/initial-named-workspace-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/initial-workspace-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPA
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/manage-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe manage-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/named-workspace-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/remove-title-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe remove-title-bar <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/workspace-rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage: komorebic.exe workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title]
[possible values: exe, class, title, path]
<ID>
Identifier as a string
Expand Down
4 changes: 0 additions & 4 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ docgen:
komorebic docgen
Get-ChildItem -Path "docs/cli" -Recurse -File | ForEach-Object { (Get-Content $_.FullName) -replace 'Usage: ', 'Usage: komorebic.exe ' | Set-Content $_.FullName }

exampledocs:
cp whkdrc.sample docs/whkdrc.sample
cp komorebi.example.json docs/komorebi.example.json

schemagen:
komorebic static-config-schema > schema.json
generate-schema-doc .\schema.json --config template_name=js_offline --config minify=false .\static-config-docs\
Loading

0 comments on commit f2c4dad

Please sign in to comment.