Building documents

Building documents

Use the asciidoctor application to build the docs. For installation information, refer to the Install and update page in the Asciidoctor documentation.

Building an entire guide

1. Navigate to the downstream/title/<guide-name> directory for the guide that you want to build. It contains a file called master.adoc.

2. Use the following command to build the guide:

   $ asciidoctor master.adoc

This generates a master.html file that you can now view in a browser.

Building a chapter or a single module

1. Navigate to the /stories or /stories/topics directory and locate the file that you want to build.

2. Use the following command to build the doc:

   $ asciidoctor <filename>.adoc

This generates a <filename>.html file that you can now view in a browser.