-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.
Configuration options
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