Skip to content
Snippets Groups Projects
Forked from Ieva Marija Dautartaite / Handbook
2 commits behind, 1 commit ahead of the upstream repository.

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.

  1. pip install -r requirements.txt
  2. 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.

  1. Open terminal
  2. 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

  1. docker build -t debug-mkdocs-shemakes .
  2. docker run --rm -it -p 8000:8000 -v ${PWD}:/docs debug-mkdocs-shemakes