From aaebc5f872d232a0aba2aa32e4931cc8a9af1cf5 Mon Sep 17 00:00:00 2001 From: makayabou Date: Sun, 6 Sep 2020 03:43:24 +0200 Subject: [PATCH] add author print and search function --- README.md | 18 ++++++++++++++++-- docs/cours/index.md | 1 + docs/cours/python/1stproject.md | 7 +++---- docs/divers/index.md | 3 +++ docs/index.md | 7 ++++--- mkdocs.yml | 5 +++++ overrides/main.html | 11 +++++++++++ requirements.txt | 1 + 8 files changed, 44 insertions(+), 9 deletions(-) create mode 100644 docs/divers/index.md create mode 100644 overrides/main.html diff --git a/README.md b/README.md index d6966e03..df464d00 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ # Introduction -Ce site répertorie la documentation du Garage Numérique, grâce au logiciel gitbook. +Ce projet contient la documentation du Garage Numérique, hébergé par Gitlab Pages grâce au logiciel MkDocs. + +# 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. + +# Contenu de la documentation La documentation est divisée en deux parties: - les cours -- les autres ressources \ No newline at end of file +- les autres ressources diff --git a/docs/cours/index.md b/docs/cours/index.md index add63662..3577f849 100644 --- a/docs/cours/index.md +++ b/docs/cours/index.md @@ -3,3 +3,4 @@ Les cours du Garage concernent: - [La présentation de l'association](presentation-garage) +- [Un cours de découverte de Python](python) diff --git a/docs/cours/python/1stproject.md b/docs/cours/python/1stproject.md index 0df0ba0f..2582e66d 100644 --- a/docs/cours/python/1stproject.md +++ b/docs/cours/python/1stproject.md @@ -4,6 +4,7 @@ ??? important "Note importante pour les étudiants" Ne créez pas un nouveau dossier, + 1. clonez plutôt le projet d'évaluation 2. basculez sur la branche start 3. Créez une nouvelle branche nommée `start-votre-id-gitlab` @@ -24,7 +25,7 @@ Ce fichier main.py contiendra les instructions principales du programme, et pour On met un **shebang** en 1ère ligne pour indiquer la version de python. -Dans ce script on déclare deux variables, qu'on nomme `base_url`et `endpoint1`, auxquelles on donne une valeur. +Dans ce script on déclare deux variables, qu'on nomme `api_url`et `endpoint`, auxquelles on donne une valeur. !!! note "main.py" ``` @@ -32,9 +33,7 @@ Dans ce script on déclare deux variables, qu'on nomme `base_url`et `endpoint1`, api_url = "https://gitlab.com/api/v4" print(api_url) - dataset = "/groups" - print(dataset) - endpoint = api_url + dataset + endpoint = api_url + "/groups" print(endpoint) ``` diff --git a/docs/divers/index.md b/docs/divers/index.md new file mode 100644 index 00000000..f516b8ac --- /dev/null +++ b/docs/divers/index.md @@ -0,0 +1,3 @@ +# Introduction + +Dans cette rubrique vous trouverez différentes astuces, mémos, snippets, tips, collectés par l'équipe du Garage Numérique. diff --git a/docs/index.md b/docs/index.md index b4daea39..4ae4e387 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,8 @@ Ce site répertorie la documentation du Garage Numérique, grâce au logiciel gitbook. -La documentation est divisée en deux parties: -- les cours -- les autres ressources +La documentation est divisée en deux parties: + +- [les cours](cours) +- [les autres ressources](divers) diff --git a/mkdocs.yml b/mkdocs.yml index ee7297bc..9c21942f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,10 +3,14 @@ site_url: https://garagenum.gitlab.io/doc site_dir: public theme: name: material + custom_dir: overrides features: - tabs plugins: - markdownmermaid + - search: + min_search_length: 2 + - git-authors markdown_extensions: - admonition - pymdownx.details @@ -45,4 +49,5 @@ nav: - cours/python/rest.md - cours/python/os-script.md - Divers: + - divers/index.md - divers/backup.md diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 00000000..8d629284 --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} + +{% block disqus %} +
+ + Authors: {{ git_page_authors }} + +
+ {% include "partials/integrations/disqus.html" %} +{% endblock %} + diff --git a/requirements.txt b/requirements.txt index 49c4a2c6..4401bc28 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,3 +6,4 @@ mkdocs>=1.1.2 mkdocs-material>=5.4.0 Pygments git+https://github.com/pugong/mkdocs-mermaid-plugin +mkdocs-git-authors-plugin