cha0s/flecks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: CLI

Browse Source
This commit is contained in:
cha0s 2024-01-27 16:58:32 -06:00
parent 9704fc4fbe
commit 6c7a4517cd
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/docs/cli.mdx
View File

@ -54,26 +54,21 @@ Options:
-h, --help display help for command -h, --help display help for command
``` ```
### `docusaurus` ### `dox`
(Implemented by `@flecks/dox`) (Implemented by `@flecks/dox`)
``` ```
Usage: flecks docusaurus [options] <subcommand> [siteDir] Usage: flecks dox [options] <subcommand> [output path]
Create a documentation website for this project. Generate documentation
The `build` and `start` subcommands are sugar on top of the corresponding Docusaurus commands.
The `create` subcommand will create a documentation website starter template for you at `siteDir`
if `siteDir` doesn't already exist (defaults to `website`). A `docusaurus.config.js`
starter configuration will also be copied to your `build` directory if it doesn't already exist.
Arguments: Arguments:
subcommand Docusaurus command to run (choices: "build", "create", "start") subcommand Generation type (choices: "docusaurus", "json")
siteDir Docusaurus directory (default: "website") output path Where the files are output
Options: Options:
-h, --help display help for command -r, --rewrite-filenames [pairs...] rewrite filenames
-h, --help display help for command
``` ```
### `lint` ### `lint`
@ -286,4 +281,3 @@ You might also stub your toe.
flecks uses [Commander.js](https://github.com/tj/commander.js#quick-start) under the hood to build its CLI. flecks uses [Commander.js](https://github.com/tj/commander.js#quick-start) under the hood to build its CLI.
It might be worth checking out their documentation for any more advanced usage. It might be worth checking out their documentation for any more advanced usage.