dream0zdmr / synthetix-docs

System and developer documentation for Synthetix

Synthetix System Documentation

These pages are built with MkDocs; for full documentation visit mkdocs.org.

This instantiation also uses PyMDown Extensions and and Mkdocs Material. See mkdocs.yml for further information about extension settings.

Run the following to get all the required dependencies:

pip install -r requirements.txt

Commands

• npm run build - Builds out markdown files for mkdocs (with a .preview extension)
• npm run build --overwrite - Builds out markdown files for mkdocs in-place
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.