doc: CLI
This commit is contained in:
parent
9704fc4fbe
commit
6c7a4517cd
|
@ -54,25 +54,20 @@ 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:
|
||||||
|
-r, --rewrite-filenames [pairs...] rewrite filenames
|
||||||
-h, --help display help for command
|
-h, --help display help for command
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -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.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user