-
Notifications
You must be signed in to change notification settings - Fork 6
README
James Moger edited this page Nov 20, 2015
·
1 revision
This documentation is built using MkDocs, a Python-based static-site generator using Markdown.
Installation on Ubuntu is very easy.
sudo apt-get install build-essential python-dev
sudo pip install mkdocs
I have not tested installation on Fedora. :(
sudo pip install mkdocs
The documentation configuration and structure is maintained in the mkdocs.yml file.
From the fathom-site directory ...
mkdocs serve
... and then launch your browser ...
I control-click the url from the terminal
... and then launch your preferred editor.
atom ~/git/fathom/fathom-site
From the fathom-site directory...
mkdocs gh-deploy
Sadly, this does not work properly yet. :(