Tutorials

GitHub Pages made with Material for MkDocs

How to contribute

To learn how to utilise the markdown syntax reference this markdown guide
To learn how to use github reference this short video or if you would like to learn more reference this long video

Running a development instance

To start a locally hosted development site first make sure that you have the latest python installed and it is in your path.

1. Clone the repository.

git clone https://github.com/Kptweedy/Tutorials.git

2. Inside the repository create a virtual environment.

python -m venv venv

3. Activate the virtual environment.

   • Windows

   .\venv\Scripts\Activate.ps1
   

   • Linux

   source /venv/bin/activate
   

4. Upgrade pip.

python -m pip install --upgrade pip

5. Install mkdocs-material and the plugins it needs.

python -m pip install mkdocs-material mkdocs-open-in-new-tab mkdocs-glightbox

6. Run the server and head to http://localhost:8000

mkdocs serve

7. Submit a Pull Request This can be done with github desktop (or git if you know how to)