gitbook.md

GitBook

Creating

1. Update dependencies

   compliance-masonry get

2. Run the gitbook command

   compliance-masonry docs gitbook LATO
   # Or
   compliance-masonry docs gitbook FedRAMP-low

The gitbook command by default will create a folder called exports that contains the files needed to create a gitbook. Visit the gitbook documentation for more information on creating gitbooks via the CLI.

Adding additional markdown content (optional)

Security documentation usually requires unstructured information that is not captured in the control documentation. The markdowns directory can be used to add this supplemental information.

1. Create a markdowns folder in the same directory as the opencontrol.yaml.

   mkdir markdowns

2. Create the markdowns/SUMMARY.md and markdowns/README.md documents.

   touch markdowns/SUMMARY.md
   touch markdowns/README.md

The content of the markdowns/SUMMARY.md and markdowns/README.md files and the files they reference is prepended to the Gitbook documentation.

For more information on using the SUMMARY.md and README.md files visit the Gitbook documentation. For an example markdowns directory visit the cloud.gov markdowns.

View locally

Requires NodeJS. After running the steps above,

1. Install the gitbook CLI

   npm install -g gitbook-cli

2. Navigate to the exports directory

   cd exports

3. Serve the gitbook site locally

   gitbook serve

4. Open the site: http://localhost:4000

After making any edits, view the changes by running

compliance-masonry get && compliance-masonry docs gitbook <certification>

Export as a PDF

1. Following the steps above

2. Navigate to the exports directory

   cd exports
   gitbook pdf ./ book.pdf

3. There should be a exports/book.pdf file that you can open with a PDF viewer.