docs-builder
Loading

Documentation Set Commands

An isolated build means building a single documentation set.

A Documentation Set is defined as a folder containing a docset.yml file.

These commands are typically what you interface with when you are working on the documentation of a single repository locally.

build is the default command so you can just run docs-builder to build a single documentation set. docs-builder will locate the docset.yml anywhere in the directory tree automatically and build the documentation.

  • build - build a single documentation set (incrementally)
  • serve - partial build and serve documentation as needed at http://localhost:3000
  • index - ingest a single documentation set to an Elasticsearch index.
  • mv - move a file or folder to a new location. This will rewrite all links in all files too.
  • diff validate - validate that local changes are reflected in redirects.yml