live

• click here

dependencies

python --version #Python 2.7.2
pip --version #pip 1.5.2

install

git clone [email protected]:snakingfire/branch-docs.git
cd branch-docs

pip install --upgrade pip
pip install mkdocs
pip install markdown-fenced-code-tabs
pip install markdown-include

development

mkdocs serve
open http://localhost:8000/

production

mkdocs gh-deploy
open https://snakingfire.github.io/branch-docs/

resources

1http://www.mkdocs.org/

1https://github.com/squidfunk/mkdocs-material

<<<<<<< HEAD 1https://github.com/facelessuser/pymdown-extensions

best practices

1folders

1must be lowercase and hyphened

1content

1bullets and sections must have new line spacing in between

1indention is 4 spaces

=======

• https://github.com/facelessuser/pymdown-extensions

origin/master