From 209ca723b8d71a14c3928955874431002ef5751c Mon Sep 17 00:00:00 2001 From: makayabou Date: Tue, 8 Dec 2020 01:01:19 +0100 Subject: [PATCH] add tabs tip for mkdocs --- README.md | 66 ++++++++------------------- docs/divers/internal/mkdocs.md | 83 ++++++++++++++-------------------- 2 files changed, 53 insertions(+), 96 deletions(-) diff --git a/README.md b/README.md index deb05706..9ca08db6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Ce projet contient la documentation du Garage Numérique, hébergé par Gitlab Pages grâce au logiciel MkDocs. -# Travailler en local +## Travailler en local Pour participer à la documentation et tester vos modifications avant de les mettre en ligne, il vous faut installer mkdocs. @@ -14,7 +14,7 @@ mkdocs serve Open up `http://127.0.0.1:8000/` in your browser. -# Ajouter du contenu +## Ajouter du contenu Chaque page de contenu correspond à un fichier markdown (.md) @@ -24,51 +24,9 @@ Pour chaque section / sous-section, il y a un fichier index.md pour lister et me Il faut aussi penser à ajouter le lien vers le nouveau fichier de contenu dans la partie `nav` de `mkdocs.yaml` -# Contenu de la documentation +## Astuces de mise en page -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 +### Insérer du code Utilisez la suite de caractères suivants ` ``` ` pour encadrer votre code: @@ -81,7 +39,7 @@ code Utilisez un seul **`** pour surligner un mot ou une phrase comme du code -## Insérer une note +### Insérer une note Utilisez la syntaxe suivante @@ -92,3 +50,17 @@ Utilisez la syntaxe suivante ``` Plus d'informations sur `https://squidfunk.github.io/mkdocs-material/reference/admonitions/` + +### Insérer un groupe avec des tabulations + +``` +=== "Python" + ``` + print(something) + ``` + +=== "Bash" + ``` + echo something + ``` +``` \ No newline at end of file diff --git a/docs/divers/internal/mkdocs.md b/docs/divers/internal/mkdocs.md index 55991252..ebaa7399 100644 --- a/docs/divers/internal/mkdocs.md +++ b/docs/divers/internal/mkdocs.md @@ -4,7 +4,7 @@ MkDocs permet de générer la documentation du Garage à partir de simples fichi Vous pouvez accéder au site à `https://garagenum.gitlab.io/doc/` -# Travailler en local +## Travailler en local Pour participer à la documentation et tester vos modifications avant de les mettre en ligne, il vous faut installer mkdocs. @@ -16,7 +16,7 @@ mkdocs serve Open up `http://127.0.0.1:8000/` in your browser. -# Ajouter du contenu +## Ajouter du contenu Chaque page de contenu correspond à un fichier markdown (.md) @@ -26,53 +26,9 @@ Pour chaque section / sous-section, il y a un fichier index.md pour lister et me Il faut aussi penser à ajouter le lien vers le nouveau fichier de contenu dans la partie `nav` de `mkdocs.yaml` -# Contenu de la documentation +## Astuces de mise en page -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 - - "Mkdocs": divers/devops/mkdocs.md - -# Astuces de mise en page - -## Insérer du code +### Insérer du code Utilisez la suite de caractères suivants ` ``` ` pour encadrer votre code: @@ -85,7 +41,7 @@ code Utilisez un seul **`** pour surligner un mot ou une phrase comme du code -## Insérer une note +### Insérer une note Utilisez la syntaxe suivante @@ -96,3 +52,32 @@ Utilisez la syntaxe suivante ``` Plus d'informations sur `https://squidfunk.github.io/mkdocs-material/reference/admonitions/` + +### Insérer un groupe avec des tabulations + +#### Code + +``` +=== "Python" + ``` + print(something) + ``` + +=== "Bash" + ``` + echo something + ``` +``` + +#### Résultat + +=== "Python" + ``` + print(something) + ``` + +=== "Bash" + ``` + echo something + ``` +