From 6c7a4517cdc02808cd0d6d6be19fa1f353339ff0 Mon Sep 17 00:00:00 2001 From: cha0s Date: Sat, 27 Jan 2024 16:58:32 -0600 Subject: [PATCH] doc: CLI --- website/docs/cli.mdx | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/website/docs/cli.mdx b/website/docs/cli.mdx index 993a11c..ea949be 100644 --- a/website/docs/cli.mdx +++ b/website/docs/cli.mdx @@ -54,26 +54,21 @@ Options: -h, --help display help for command ``` -### `docusaurus` +### `dox` (Implemented by `@flecks/dox`) ``` -Usage: flecks docusaurus [options] [siteDir] +Usage: flecks dox [options] [output path] -Create a documentation website for this project. - -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. +Generate documentation Arguments: - subcommand Docusaurus command to run (choices: "build", "create", "start") - siteDir Docusaurus directory (default: "website") + subcommand Generation type (choices: "docusaurus", "json") + output path Where the files are output Options: - -h, --help display help for command + -r, --rewrite-filenames [pairs...] rewrite filenames + -h, --help display help for command ``` ### `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. It might be worth checking out their documentation for any more advanced usage. -