Fru.io Documentation
Contributions
Edits, additions, corrections, etc are most welcome. Our docs live in the docs
folder and are written in Markdown.
Development
Prereqs
- A system capable of running Docker
Clone the repo
git@github.com:drud/docs.git
Build and run the container
docker build -t Fru-mkdocs .
docker run -it --rm -p 8000:8000 Fru-mkdocs
Workflow
- Edit docs as you see fit
- Build and run the container
- View your changes in the local environment at
http://localhost:8000
- Submit a pull request to this repository
Note
The workflow above can be made simpler/faster by running mkdocs
locally or by mounting a volume to the running container