# Install the following. Installation procedure may vary by platform.
# - Python 2.7
# - pip
# - virtualenv
# Create a virtualenv and activate it
virtualenv ractivejs.github.io
cd ractivejs.github.io
source ./bin/activate
# Fork this repo and clone your fork.
git clone [email protected]:YOUR_USERNAME/ractivejs.github.io.git src
cd src
# Install dependencies
pip install -r requirements.txt
# Serve the site
mkdocs serve
# Build the site
mkdocs build
# When done developing, deactivate the virtualenv
deactivate
Refer to the mkdocs site for more information.
- Everything is written in vanilla Markdown.
- Everything goes in the
docs
directory. - Old documentation can be found in the
legacy
directory. - The nav bar is managed in
mkdocs.yml
.