Prism Docs

This repo collects the collaborative work on Prism documentation. Official documentation is hosted at Prism Docs page.

Documentation is auto-generated from Markdown files in this repo.

MkDocs is used to serve the docs locally with different theming.

Prerequisites

Install MkDocs

pip install mkdocs

Additionally, install Material theme:

pip install mkdocs-material

Install

Doc repo can be fetched from GitHub:

git clone [email protected]:ultravioletrs/prism-docs.git

Usage

Use MkDocs to serve documentation:

mkdocs serve

Then just point the browser to http://127.0.0.1:8000.