Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • A Atelier Gitlab Flavored Markdown
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Deployments
    • Deployments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Terraform modules
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar

La forge institutionnelle d'INRAE étant en production depuis le 10 juin 2025, nous vous recommandons d'y créer tous vos nouveaux projets.

  • Poulard Christine
  • Atelier Gitlab Flavored Markdown
  • Wiki
  • Home

Home · Changes

Page history
Update home authored Jul 11, 2022 by Poulard Christine's avatar Poulard Christine
Hide whitespace changes
Inline Side-by-side
home.md
View page @ 03b01bff
# Atelier Gitlab Flavored Markdown
pour regrouper ici toutes les infos pour rédiger ce **readme.md** et toute la partie wiki, surtout celles qui sont difficiles à trouver (attention, les fonctions évoluent ! ! )
Auteur : C. Poulard, 2022
## Objectif :
GitLab offre la possibilité de rédiger des pages en markdown pour accompagner le code. C'est une fonctionnalité intéressante, mais le format Markdown utilisé est spécifique. On parlera donc de "GitLab Flavored Markdown", qui est différent du "GitHub Flavored Markdown" et du Markdown Standard.
L'objectif est de regrouper ici toutes les infos glanées en rédigeant des **readme.md** et des **wiki**, en insistant sur celles qui sont difficiles à trouver.
Difficulté : les fonctions évoluent ! !
Le lecteur peut rechercher ce qui l'intéresse dans le texte. L'idéal serait qu'il puisse accéder au fichier markdown ; c'est le cas pour le read.me, qui est téléchargeable.
:warning: vérifier si c'est le cas pour le wiki !!
Sinon, les fichiers markdown rédigés pour ce wiki seront ajoutés manuellement au repo, avec le risque d'un petit décalage entre le fichier et la dernière mise à jour...
## Structure de ces pages
Ces pages sont actuellement "en construction", dans un premier temps toutes les infos sont placées dans une page, en attendant une structuration en plusieurs pages, qui est de toutes façons indispensable pour "jouer" avec les liens.
## Sommaire
**un sommaire sera inséré ici**, cela fait partie des fonctions à présenter !
## Utilisation du wiki en complément du repo
On donnera ici :
- quelques avantages de remplir le readme et le wiki : informations sur le code mis à disposition (contact, contexte, aide à l'installation et à l'utilisation...) **faciles à mettre à jour** !
- quelques inconvénients par rapport à une doc classique :disappointed:
- si on veut profiter du format wiki il faut réfléchir à la structure et consacrer du temps de rédaction (un peu lourd), et bien sûr **apprivoiser le markdown spécifique à GitLab** !
-
- une note sur les **autorisations** : le propriétaire d'une page peut gérer des droits d'édition du wiki, indépendamment des droits du repo
## Fonctions de base
Les fonctions courantes seront très faciles à trouver via un tuto et via la barre d'outils, elles seront donc peu détaillées ici :
- niveaux de titre (header) avec des dièses : un `#` par niveau de titre, suivi d'une >kbd>espace</kbd> ; c'est traître car pour les symboles pour le gras `*` et l'italique `_` il ,n'en faut pas !
......
Clone repository
  • _sidebar
  • exemples mermaid
  • Home
  • mermaid
  • tests