add author print and search function

This commit is contained in:
makayabou 2020-09-06 03:43:24 +02:00
parent 3248e48d50
commit aaebc5f872
8 changed files with 44 additions and 9 deletions

View File

@ -1,7 +1,21 @@
# Introduction # 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: La documentation est divisée en deux parties:
- les cours - les cours
- les autres ressources - les autres ressources

View File

@ -3,3 +3,4 @@
Les cours du Garage concernent: Les cours du Garage concernent:
- [La présentation de l'association](presentation-garage) - [La présentation de l'association](presentation-garage)
- [Un cours de découverte de Python](python)

View File

@ -4,6 +4,7 @@
??? important "Note importante pour les étudiants" ??? important "Note importante pour les étudiants"
Ne créez pas un nouveau dossier, Ne créez pas un nouveau dossier,
1. clonez plutôt le projet d'évaluation 1. clonez plutôt le projet d'évaluation
2. basculez sur la branche start 2. basculez sur la branche start
3. Créez une nouvelle branche nommée `start-votre-id-gitlab` 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. 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" !!! 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" api_url = "https://gitlab.com/api/v4"
print(api_url) print(api_url)
dataset = "/groups" endpoint = api_url + "/groups"
print(dataset)
endpoint = api_url + dataset
print(endpoint) print(endpoint)
``` ```

3
docs/divers/index.md Normal file
View File

@ -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.

View File

@ -2,7 +2,8 @@
Ce site répertorie la documentation du Garage Numérique, grâce au logiciel gitbook. Ce site répertorie la documentation du Garage Numérique, grâce au logiciel gitbook.
La documentation est divisée en deux parties: La documentation est divisée en deux parties:
- les cours
- les autres ressources - [les cours](cours)
- [les autres ressources](divers)

View File

@ -3,10 +3,14 @@ site_url: https://garagenum.gitlab.io/doc
site_dir: public site_dir: public
theme: theme:
name: material name: material
custom_dir: overrides
features: features:
- tabs - tabs
plugins: plugins:
- markdownmermaid - markdownmermaid
- search:
min_search_length: 2
- git-authors
markdown_extensions: markdown_extensions:
- admonition - admonition
- pymdownx.details - pymdownx.details
@ -45,4 +49,5 @@ nav:
- cours/python/rest.md - cours/python/rest.md
- cours/python/os-script.md - cours/python/os-script.md
- Divers: - Divers:
- divers/index.md
- divers/backup.md - divers/backup.md

11
overrides/main.html Normal file
View File

@ -0,0 +1,11 @@
{% extends "base.html" %}
{% block disqus %}
<div class="md-source-date">
<small>
Authors: {{ git_page_authors }}
</small>
</div>
{% include "partials/integrations/disqus.html" %}
{% endblock %}

View File

@ -6,3 +6,4 @@ mkdocs>=1.1.2
mkdocs-material>=5.4.0 mkdocs-material>=5.4.0
Pygments Pygments
git+https://github.com/pugong/mkdocs-mermaid-plugin git+https://github.com/pugong/mkdocs-mermaid-plugin
mkdocs-git-authors-plugin