Skip to content
This repository has been archived by the owner on Mar 4, 2020. It is now read-only.

Latest commit

 

History

History
42 lines (25 loc) · 1.73 KB

README.md

File metadata and controls

42 lines (25 loc) · 1.73 KB

Contributing

Welcome! We are very pleased that you came by to help use enhance this wiki.

To contribute, you can click on the Fork button on the upper right side of this page. This will make a copy of this repo in your GitHub account. Once it is done, make every changes you want and then create a new pull request so we can review your changes and finally add them to our repo if we juge them legit.

Running the wiki localy

If you want to enhance this wiki, you should see your changes localy on your computer. To do so, you need a few steps.

Installation

You first need to install the needed packages, first you need to have the Python package manager and run this command:

pip install --upgrade mkdocs mkdocs-material mkdocs pymdown-extensions

This will isntall all dependeces needed. That's all.

Run a live server

Mkdocs offers us the possibility to run a local server in just one command, and debug very quickly our work. Just move to the root directory of this repo and run:

mkdocs serve

You will then have access to the running server at the URL: http://127.0.0.1:8000.

Finding doc

You will find a lot of docs about Mkdocs and the Mkdocs-material theme on there respective pages (clickable links).

Now you are good to go. Have fun.





Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.