Get access to the full Epitech documentation It is also available here
-
Install mkdocs:
$> pip install mkdocs
-
MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it.
Make sure you're in the same directory as the mkdocs.yml configuration file, and then start the server by running mkdocs serve command:$ mkdocs serve INFO - Building documentation... INFO - Cleaning site directory INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration: - c_programming/helloworld_knowmore.md INFO - Documentation built in 0.23 seconds INFO - [17:04:12] Watching paths for changes: 'docs', 'mkdocs.yml' INFO - [17:04:12] Serving on http://127.0.0.1:8000/ INFO - [17:04:26] Browser connected: http://127.0.0.1:8000/
-
Open up http://127.0.0.1:8000/ in your browser, and you'll see the default home page being displayed:
-
Gh-Pages is used to deploy our documentation
Everyone can contribute especially Epitech Students
- Fork it!
- Clone the folder to have a copy locally
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'feat: add some feature'
- Push to the branch:
git push origin -u my-new-feature
- Create a pull request
Write to any collaborators of EPITOOLS to get more informations or report any issue
Thanks goes to these wonderful people:
blacky-yg |
NemesisX1 |
pinhero |
Aman M |