SheMakes.eu handbook
This is the source repository for the handbook published at:
See License
How to run website locally
After cloning the Git repo, you can run the website on your device in a few way, depending on what you are comfortable with.
By installing Mkdocs
Check the documenation from Mkdocs to install on your computer. This can become complicated depending on your system.
pip install -r requirements.txt
python3 -m mkdocs serve
By using docker
You could also install Docker which can have a smaller setup time.
After installing, build the initial project image for the container:
docker build -t debug-mkdocs .
Then you can start up a dev server using:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs debug-mkdocs
Open your browser to localhost:8000 to view the website.
The server will rebuild the website everytime you make changes to the docs/
folder.
- Open terminal
- copy the text below (cd ) in terminal: cd then drag the folder in
note for below: yoou dont need to do the build every time, only when you install a new plug-in
- docker build -t debug-mkdocs-shemakes .
- docker run --rm -it -p 8000:8000 -v ${PWD}:/docs debug-mkdocs-shemakes