|
|
|
|
# Introduction
|
|
|
|
|
|
|
|
|
|
Ce projet contient la documentation du Garage Numérique, hébergé par Gitlab Pages grâce au logiciel MkDocs.
|
|
|
|
|
test, je peux modifier ?
|
|
|
|
|
|
|
|
|
|
# Travailler en local
|
|
|
|
|
|
|
|
|
|
Pour participer à la documentation et tester vos modifications avant de les mettre en ligne, il vous faut installer mkdocs.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
pip install mkdocs
|
|
|
|
|
pip install -r requirements.txt
|
|
|
|
|
mkdocs serve
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Open up `http://127.0.0.1:8000/` in your browser.
|
|
|
|
|
|
|
|
|
|
# Ajouter du contenu
|
|
|
|
|
|
|
|
|
|
Chaque page de contenu correspond à un fichier markdown (.md)
|
|
|
|
|
|
|
|
|
|
La documentation est divisée en sections, et en sous-sections.
|
|
|
|
|
|
|
|
|
|
Pour chaque section / sous-section, il y a un fichier index.md pour lister et mettre des liens vers les différents contenus de la section.
|
|
|
|
|
|
|
|
|
|
Il faut aussi penser à ajouter le lien vers le nouveau fichier de contenu dans la partie `nav` de `mkdocs.yaml`
|
|
|
|
|
|
|
|
|
|
# Contenu de la documentation
|
|
|
|
|
|
|
|
|
|
La documentation est divisée en deux parties:
|
|
|
|
|
- Accueil: index.md
|
|
|
|
|
- Cours:
|
|
|
|
|
- Introduction: cours/index.md
|
|
|
|
|
- "Présentation du Garage":
|
|
|
|
|
- cours/presentation-garage/index.md
|
|
|
|
|
- cours/presentation-garage/equipe.md
|
|
|
|
|
- cours/presentation-garage/histoire.md
|
|
|
|
|
- cours/presentation-garage/projets.md
|
|
|
|
|
- cours/presentation-garage/statut.md
|
|
|
|
|
- Ressources:
|
|
|
|
|
- cours/presentation-garage/ressources/sites-web.md
|
|
|
|
|
- Python:
|
|
|
|
|
- cours/python/index.md
|
|
|
|
|
- cours/python/workspace.md
|
|
|
|
|
- cours/python/1stproject.md
|
|
|
|
|
- cours/python/rest.md
|
|
|
|
|
- cours/python/os-script.md
|
|
|
|
|
- Divers:
|
|
|
|
|
- divers/index.md
|
|
|
|
|
- "Commandes Linux":
|
|
|
|
|
- "Index": divers/cmd/index.md
|
|
|
|
|
- divers/cmd/backup.md
|
|
|
|
|
- divers/cmd/screen.md
|
|
|
|
|
- divers/cmd/nmcli.md
|
|
|
|
|
- divers/cmd/mount.md
|
|
|
|
|
- "Admin Sys":
|
|
|
|
|
- Index: divers/adminsys/index.md
|
|
|
|
|
- "Installer Adobe pdf reader": divers/adminsys/acroread-debian.md
|
|
|
|
|
- "Configurer Gnome AppFolders": divers/adminsys/gnome-appfolders.md
|
|
|
|
|
- "Déploiement de Serveurs":
|
|
|
|
|
- "Index": divers/guides/index.md
|
|
|
|
|
- divers/guides/install_pxe.md
|
|
|
|
|
- "Nextcloud": divers/guides/nextcloud_docker-compose_on_debian-10_with_nginx_reverse-proxy.md
|
|
|
|
|
- "Wordpress": divers/guides/wordpress_docker-compose_on_debian-10_with_nginx_reverse-proxy.md
|
|
|
|
|
- "SSH - SAMBA": divers/guides/serveur_debian_smb_ssh.md
|
|
|
|
|
- "DevOps":
|
|
|
|
|
- "Index": divers/devops/index.md
|
|
|
|
|
- "Hugo": divers/devops/hugo.md
|
|
|
|
|
|
|
|
|
|
# Astuces de mise en page
|
|
|
|
|
|
|
|
|
|
## Insérer du code
|
|
|
|
|
|
|
|
|
|
Utilisez la suite de caractères suivants ` ``` ` pour encadrer votre code:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#```
|
|
|
|
|
Ceci est du
|
|
|
|
|
code
|
|
|
|
|
#```
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Utilisez un seul ` ` ` pour surligner un mot ou une phrase comme du code
|
|
|
|
|
|
|
|
|
|
## Insérer une note
|
|
|
|
|
|
|
|
|
|
Utilisez la syntaxe suivante
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
!!! note "Lisez bien cette note"
|
|
|
|
|
En indentant vos lignes à partir de cet tag `!!! note`,
|
|
|
|
|
vous obtenez un encadré dans le texte.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Plus d'informations sur `https://squidfunk.github.io/mkdocs-material/reference/admonitions/`
|
