The theme is ready to accept the following options from your configuration:
Use the documentation.js CLI
$ npx documentation build **/_types/*.js --theme . -f html -o example/app
--theme flag should point to the module (index.js) of the theme.
There are a few
npm script tasks which you can use:
Order is important, so it's recommended you start a separate terminal session for each task.
Takes care of templates.
bundlefolders into a target
distfolder. Thus, ensure that assets are bundled before they are moved.
Delivers results to the browser and reloads on changes.
develop:themestores its results.
distfolder as a static site
Please commit the results of
assets/bundle. This simplifies the workflow of publishing them to
Raw/Source styles and scripts in
assets/styles are ignored and not published to