Anonymous View
0.0.1 • Published 9 years ago

docula-cli v0.0.1

Weekly downloads
1
License
MIT
Repository
-
Last release
9 years ago

Docula-cli

CLI module for generating a static html content for websites based on Docula.

Usage

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

Commands

  • 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

Examples

Options

Configuration options

OptionTypeDefaultDescription
gitstring or objectPass an URL to your repository or an object if you want to add additional details
git.originstringhttps:// or git:// url to clone your documentation repo
git.branchstringmasterChoose a branch to pull from
git.clonePathstringin your system temp folder, derived from repository URLChoose a local filesystem URL where Docula will clone the repo
pageTitlestringDoculaTitle string to use for HTML document; Whole title will be ${pageTitle}: ${articleName}
logostringIf 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
topNavigationstringIf 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.headstringA piece of HTML to insert into a of each Docula page; use it to include own scripts or styles or anything else
googleAnalyticsKeystringWhen given, will include a Google Analytics module configured with a provided key
disqusKeystringWhen given, will enable Disqus-based comments under each article
cssThemestringWhen given, will treat as a relative path within your repository to find a custom sass theme for Docula