kieranfraser / AR.js-Docs

Documentation for AR.js, made with MkDocs

AR.js Documentation

🚀Live Documentation: https://ar-js-org.github.io/AR.js-Docs/

Development

Docs are based on https://www.mkdocs.org/.

To modify the Docs, you need to push to the master branch.

To publish them (they are currently hosted on Github Pages), you need to perform the steps below.

Installation

First you need to install mkdocs. You can easily install this with Homebrew.

brew install mkdocs

Then you need to install the theme:

pip3 install mkdocs-bootswatch
# or pip install mkdocs-bootswatch

Running

Run mkdocs serve to serve the site locally.

Deploying

mkdocs gh-deploy