Skip to content
Extraits de code Groupes Projets
README.md 1,9 ko
Newer Older
Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé
# Modèle de site mkdocs

## Contenu du modèle

Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé
Ce projet est un modèle minimaliste pour publier un premier site avec [mkdocs](https://mkdocs.org).

Pour produire du contenu, on peut consulter [le tutoriel de Franck
Chambon](https://ens-fr.gitlab.io/tuto-markdown/premier/) ou le [tutoriel
avancé](https://ens-fr.gitlab.io/mkdocs/) du même auteur.

Avant de publier votre site, n'oubliez pas de modifier les éléments dans le
fichier `mkdocs.yml`

La page d'accueil de votre site correspondra à la page générée par le fichier [docs/index.md](./docs/index.md)

Les pages apparaitront ensuite dans l'ordre des dossiers. Ainsi, pour faire apparaitre une page «chapitre 1» avec une page  d'activité et un page de cours, on peut utiliser la structure suivante :
```
docs/index.md
    /chapitre1/index.md
              /activite.md
              /cours.md
```

Afin de modifier le titre affiché pour le chapitre, il suffit de modifier le
fichier [docs/chapitre01/.pages](.docs/chapitre01/.pages)

## Méthode de publication du modèle

Ce modèle permet de publier un site web de façon collaborative en tirant intensivement parti des fonctionnalités de _<dfn title="Requête de fusion : demande de fusionner une branche dans une autre">merge request</dfn>_ et de commenter les modifications apportées.
Vincent-Xavier Jumel's avatar
Vincent-Xavier Jumel a validé

![Création du commit initial dans la branche](./doc/creation_commit_initial_branch.png)
![Création de la requête de fusion](./doc/creation_requete_fusion.png)
![Visualisation des modifications apportées](./doc/visualisation_modifications_initiales.png)
![Construction du site](./doc/construction_site.png)
![Visualisation du résultat](./doc_visualisation_site.png)
![Sélectionner le texte à commenter](./doc/selectionner_texte_a_commenter.png)
![Faire un commentaire](./doc/faire_commentaire.png)
![Répondre à un commentaire](./doc/repondre_a_un_commentaire.png)
![Voir et appliquer une suggestion](./doc/voir_suggestion.png)