DocGen is a command-line (CLI) tool which takes plain text or markdown input files and outputs a static website. It also optionally outputs a PDF copy of the website content.
DocGen works by transforming an input directory (source files) into an output directory (website + PDF).
The DocGen command-line interface includes usage help for both the tool and its subcommands:
docgen --help
docgen run --help
Use the scaffold command for creating a new project. It creates an example input directory, by generating the minimum the skeleton input files required by DocGen. After generating them, you can customise them to create your website.
Create a scaffold template in the working directory (./):
docgen scaffold
Create a scaffold template in a specified directory:
docgen scaffold -o $HOME/docgen-example
The run command transforms an input directory (plain text source) into an output directory (HTML+PDF).
Basic usage:
docgen run -i $HOME/docgen-example -o $HOME/docgen-output
Optionally create a PDF:
docgen run -i $HOME/docgen-example -o $HOME/docgen-output -p
Optionally create a redirect page:
docgen run -i $HOME/docgen-example -o $HOME/docgen-output -r
The optional redirect page is an 'index.html' file that is placed in the output's parent directory. The redirect page redirects the user to the homepage in the output directory. This is mostly useful for hosting the website without having to place all the files in the root directory.