RUNNING-DOCS-LOCALLY.md

Running docs locally

The following is only required if you are part of the Quix technical writing team, or you contribute frequently, and want to check your docs PR locally before pushing up to the docs repo. Otherwise, the simplest approach is to refer to the docs preview site that is created automatically for you, when you push up a PR on the dev branch.

Prerequisites

To run these docs locally you'll need:

• Material for MkDocs
• Sign up to the Insiders Programme, if you want to see all features rendered locally.
• A Git client (the command line is fine).

Plugins used

If you want to fully render all documentation locally you need to install the following plugins with pip install:

• mkdocs-glightbox
• mkdocs-multirepo
• mkdocs-redirects

You also need to sign up to the Insiders Programme.

The social plugin is also used to automatically provide metadata. See the social plugin documentation for details on how to install the dependencies of the plugin. You might also need to first install cffi with pip install cffi, if not present on your system.

Linked repositories

This repo uses the multirepo plugin to pull in client library content from the Quix Streams repo.

You can read more about Quix Streams here.

Viewing the docs

To view the docs locally:

1. Follow the install guide for Material here.

2. Clone the repo as follows:

   git clone https://github.com/quixio/quix-docs.git
   

3. Change into the docs directory you cloned (there will be a mkdocs.yml file there).

4. Run mkdocs serve.

5. Navigate your browser to localhost:8000 to view the docs.