2018-07-04 13:20:03 +00:00
|
|
|
Installation
|
|
|
|
|
|
|
|
|
|
1. brew install mkdocs
|
|
|
|
|
2. pip install mkdocs-material
|
|
|
|
|
3. pip install fontawesome_markdown
|
2021-01-05 18:48:13 +00:00
|
|
|
4. `npm install -g license-checker`
|
2018-07-04 13:20:03 +00:00
|
|
|
|
|
|
|
|
To build, navigate to the root of this repo and run:
|
|
|
|
|
mkdocs build --clean
|
2018-09-28 09:57:13 +00:00
|
|
|
mkdocs serve
|
2018-07-08 16:44:29 +00:00
|
|
|
|
2018-09-03 14:50:28 +00:00
|
|
|
To deploy, run the following:
|
|
|
|
|
|
|
|
|
|
`rsync -avz --exclude .git/ --del -e "ssh -p 722" ~/git/dcdocs/site/ macropeo@77.72.0.226:/home/macropeo/docs.datacontroller.io`
|
|
|
|
|
|
2018-07-08 16:44:29 +00:00
|
|
|
Note that the readme has been renamed to README.txt to prevent github pages from considering it to be the index by default!
|
