Skip to content

Contributing

How to contribute

To learn how to write in markdown 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.

MkDocs-Material Documentation.

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

  • Clone the repository.

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

  • Inside the repository create a virtual environment.

    python -m venv venv
    

  • Activate the virtual environment.

.\venv\Scripts\Activate.ps1
source /venv/bin/activate
  • Upgrade pip.

    python -m pip install --upgrade pip
    

  • Install mkdocs-material and the plugins it needs.

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

  • Run the server and head to http://localhost:8000

    mkdocs serve
    

Stuff to do