Setup¶
Before you start writing and building docs, you need to install some development tools and configure your local device. Here's what you need to go.
Prerequisites¶
Install MkDocs¶
The docs are built using the MkDocs static site generator. MkDocs is a fast and lightweight static site generator that builds HTML sites we can host internally or externally.
Follow these instructions to install MkDocs.
Install Material for MkDocs¶
The theme we use for the docs is a custom version of the Material Design theme for MkDocs.
Follow these instructions to install the MkDocs-Material theme.
Install GitHub Desktop¶
To download doc files to your local device and push content changes live, you need to install GitHub Desktop.
Download the installer and follow the on-screen instructions to install GitHub Desktop.
Install a Source Code Editor¶
To write docs, you need to install a source code editor. Due to its seamless integration, we recommend you use VS Code but you are welcome to use another app as desired.
Download the installer and follow the on-screen instructions to install VS Code.
Further Reading¶
Learn more about Material for MkDocs