Local MkDocs Testing¶

This is a short canned synopsis for running MkDdocs locally while editing the docs.

Install MkDocs¶

#  mkdocs is python-based
pip3 install mkdocs

# or on mac systems
brew install mkdocs

Install Extensions¶

pip3 install -r requirements.txt
pip3 install -r python_scripts/requirements.txt

This installs the mkdocs-material theme which we use along with other dependencies.

To enable syntax highlighting for tremor-script/trickle code snippets, install our mkdocs-specific, tremor lexer, as well:

.github/scripts/install-lexer.sh

Generate Dynamic Documentation and Configuration¶

make

This auto-generates the doc files for tremor stdlib and cli and also produces the default config file for mkdocs, (mkdocs.yml) file, at the end (with the right navigation references to the generated stdlib docs).

Build Documentation¶

mkdocs build

Local Doc Service¶

mkdocs serve

The doc site will be available at http://127.0.0.1:8000/ for reviewing (supports live-reload, as you edit).