diff --git a/docs/command_reference.md b/docs/command_reference.md new file mode 100644 index 0000000..cb5b8d2 --- /dev/null +++ b/docs/command_reference.md @@ -0,0 +1,42 @@ +# Djot command reference + +[Back to main page](./index.md) + +## Installation + +```shell +cargo install simple-ssg +``` + +## Building Locally + +```shell +git clone https://github.com/ryanabx/simple-ssg +cd simple-ssg +cargo build --release +``` + +## Usage + +```shell +Plain and simple static site generator for Djot and Markdown light markup languages + +Usage: simple-ssg [OPTIONS] [DIRECTORY] + +Arguments: + [DIRECTORY] Path to the directory to use to generate the site (not required if -f is specified) + +Options: + -f Process a single file instead of a directory + -o Optional output path override. Defaults to ./output for directories + --clean Clean the output directory before generating the site. Useful for multiple runs + --web-prefix Specify the website prefix (defaults to local paths i.e. `./`) + -t, --template