https://github.com/buathiertom/reservetonlogisdoc
Documentation utilisateur markdown hebergé sur github-pages avec mkdocs
https://github.com/buathiertom/reservetonlogisdoc
gh-pages markdown mkdocs
Last synced: about 1 month ago
JSON representation
Documentation utilisateur markdown hebergé sur github-pages avec mkdocs
- Host: GitHub
- URL: https://github.com/buathiertom/reservetonlogisdoc
- Owner: BuathierTom
- Created: 2023-12-11T07:54:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-11T14:15:10.000Z (over 1 year ago)
- Last Synced: 2023-12-12T09:31:10.297Z (over 1 year ago)
- Topics: gh-pages, markdown, mkdocs
- Homepage: https://buathiertom.github.io/ReserveTonLogisDoc/
- Size: 2.79 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ReserveTonLogisDoc
Documentation utilisateur markdown heberger sur github-pages avec mkdocs
## Déploiement local
Pour déployer le serveur en local :
```bash
pip install mkdocs
```
Pour build :
```bash
mkdocs build
```
Et lancer le server sur : http://127.0.0.1:8000/
```bash
mkdocs serve
```
## Déploiement gh-pages
Pour déployer le serveur sur github pages :
```bash
mkdocs gh-deploy
```
## Générer le PDF
Installation de pandoc : https://pandoc.org/installing.html
Installation de MikTex : https://miktex.org/download
Déplacez vous dans le dossier /docs
```bash
cd docs
```
Commande pour générer les pdf en fonction du fichier md :
```bash
pandoc -s votre_fichier.md -o votre_fichier.pdf
```
## Documentation
Lien vers la [documentation de ReserveTonLogis](https://buathiertom.github.io/ReserveTonLogisDoc)
## Auteurs
- [@BuathierTom](https://www.github.com/BuathierTom)
- [@Mayel16](https://www.github.com/Mayel16)
- [@adriengmbt](https://www.github.com/adriengmbt)
- [@crepincorentin](https://www.github.com/crepincorentin)