docs.peeringdb.com site
HTML
Latest commit c942200 Jan 17, 2017 Chris Caputo Board meeting.

README.md

PeeringDB Documentation

As viewable at http://docs.peeringdb.com/

NOTE Please do not put issues here anymore, new issues should be created at https://github.com/peeringdb/peeringdb/issues

Modifying these docs

To work on and change these documents, you'll need python and pip.

  • CentOS sudo yum install python-pip

Install MkDocs

pip install mkdocs

Clone the repo (fork first and clone your copy)

git clone git@github.com:peeringdb/docs.git
cd docs

Start mkdocs

mkdocs serve

or, if you'd like to specify the port, use -a $ADDRESS:$PORT, for example:

mkdocs serve -a 0.0.0.0:7889

You should now see a message similar to: Serving on http://127.0.0.1:8000

Point your browser at that URL, and you'll get real time updates to the generated documentation as you edit.

Updating the site

mkdocs gh-deploy