Skip to content

Latest commit

 

History

History
22 lines (12 loc) · 588 Bytes

README.md

File metadata and controls

22 lines (12 loc) · 588 Bytes

Ninefold Docs README

To get started with editing the docs you need a couple of tools installed on your machine.

  1. Install brew
  2. Python

Easy with brew - just brew install python

  1. MkDocs

Easy with python - just pip install mkdocs

  1. Clone this repo to you local machine

MkDocs commands

mkdocs build will build a copy of the site locally. It will create a site dir in your local repo.

mkdocs serve will host the site on your local machine listening on http://0.0.0.0:8000

mkdocs gh-deploy will push to gh-pages branch (tested, but don't do this yet till content complete)