Docula-cli

Usage

git clone "path_to_cli_repo"
cd docula-cli
npm i -g
docula-cli [command]

static [options] - generating a static html content for websites based on Docula
reset [url] - completely reset redis, delete local repository clone folder, reset ElasticSearch, and restart itself completely from scratch

-h, --help - providers usage information.
-b, --base-path [path] - base path provides a path where Docula is available (e.g: '/docs').
-g, --git-remote [repo] - url to a remote repository with documentation (e.g: https://github.com/jaredwray/docula-kb).
-o, --output-dir [directory] - path to directory where generated static content will be served (e.g: 'static/').
-f --file [file] - path to a json configuration file.

Option	Type	Default	Description
git	string or object		Pass an URL to your repository or an object if you want to add additional details
git.origin	string		https:// or git:// url to clone your documentation repo
git.branch	string	master	Choose a branch to pull from
git.clonePath	string	in your system temp folder, derived from repository URL	Choose a local filesystem URL where Docula will clone the repo
pageTitle	string	Docula	Title string to use for HTML document; Whole title will be `${pageTitle}: ${articleName}`
logo	string		If set, will treat it as an URL for a logo image to show in page headers; otherwise will try to look for an image file like "logo.png" or "logo.jpg" etc in the root of your repository
topNavigation	string		If set, will use it as a relative path from the root of your repository to find a file where a piece of HTML would be to put at the top of all Docula pages; use it to insert your website navbar or other relevant content
config.head	string		A piece of HTML to insert into a of each Docula page; use it to include own scripts or styles or anything else
googleAnalyticsKey	string		When given, will include a Google Analytics module configured with a provided key
disqusKey	string		When given, will enable Disqus-based comments under each article
cssTheme	string		When given, will treat as a relative path within your repository to find a custom sass theme for Docula