###### Tags: `IndieCamp` `Kerbors` `atelier geek`

# [[IndieCamp Kerbors](https://frama.link/indiecamp-kerbors-2017)] Atelier Geek - Session #1

* [Atelier #0](https://hackmd.io/s/rJw31KgDb)
* [Atelier #1](https://hackmd.io/s/rJDXkRHDW)
* [Atelier #2](https://hackmd.io/s/SyHcRZPPb)

Ce PAD décrit un atelier d'initiation à la **syntaxe markdown** réalisé sur l'indiecamp à Kerbors.

Ce document est mis à disposition par tou.te.s les contributeurs et contributrices de l'Indiecamp Kerbors 2017, selon les termes de la [licence Creative Commons CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).

<img style="display: block; margin: 0 auto;" src="https://mirrors.creativecommons.org/presskit/buttons/88x31/png/by-sa.png" width="40%">

## 20 minutes pour découvrir la syntaxe [Markdown](https://fr.wikipedia.org/wiki/Markdown)

Markdown est un langage de **balisage** (...) léger créé par John Gruber en 2004. Son but est d'offrir une syntaxe facile à lire et à écrire. Un document formaté selon Markdown devrait pouvoir être publié comme tel, en texte, sans donner l’impression qu’il a été marqué par des balises ou des instructions de formatage. (...)

## Héberger du markdown et collaborer sur un fichier

L'intention est de stoker et publier un fichier .md pour le rendre visible et éditable par plusieurs personnes et retrouver l'historique de modifications du document (monfichier.md). Pour cela nous allons utiliser GitHub, pas trop méchant mais pas trop gentil comme "outil" car il 'centralise' complétement l'open source (ce qui est un paradoxe non négligeable).

Une fois ton compte créé sur github, tu crées ce qui est appelé un repository, en français c'est un "dépot". Un repo se comporte comme un fichier. Par ex. `moncompte github/kerbors-doc`.

:::info
Pour ne pas s'emmerder, cocher la case "créer un README.md lors de la création d'un repository. Cela vous sera utile par la suite. Le fichier est enregistré en .md (markdown).
:::

Vous pouvez "enregistrer" au travers d'un **commit**, une manière d'enregistrer la modification du fichier.md avec un commentaire sur la modification. Il s'agit de donner un titre pour la modification réalisée ("je nomme ce que fais"), puis de fournir une (petite) explication de ce qui a été fait. Cela permet à d'autres personnes, contributrices ou non de ce fichier, de comprendre l'intention de modification et donc de faciliter la collaboration d'écriture à plusieurs du fichier.

Lors du commit, il y a deux possibilités :
+ **Faire un commit sur "branch master"** : la modif. sera enregistrée et publiée (si vous avez les droits sur fichier.md). Ce n'est pas forcement la meilleure option pour collaborer.
+ **Faire un commit dans une nouvelle branche** en cochant la case sous `branch master` lors de l'enregistrement du commit. Cela crée une nouvelle branche liée à la racine de la branch master. Cela permet d'ouvrir un discussion, via la création d'un **pull request**, ce qui permet de proposer à plusieurs personnes de travailler jusqu'à accord sur l'amélioration. Un fois toutes les améliorations faites `moncompte/kerbors-doc/README.md` sur la branche de travail dans la pull request, vous pouvez valider, pour les administrateurs ou propriétaires de compte GitHub, la pull request. Écrire en markdown, héberger un fichier, collaborer à plusieurs pour améliorer une documentation ou un site web vous sera alors possible.

Vous pourrez ensuite créer un site à partir de fichier.md via votre compte GitHub en utilisant "setings" puis cocher "créer une github pages" qui donnera une adresse url kerbors-doc.github.io. Ex : [xavcc.github.io](https://xavcc.github.io/) provient de https://github.com/XavCC/xavcc.github.io

## Discussions

Évocation de la technologie [Git](https://fr.wikipedia.org/wiki/Git) (initié pour le dev. de Linux), de gestion de versions (de programmes), du concept de branches de contributions et du "fork" (fourche de contribution).

## Plus loin aller