From d338d3adb57428e270e2acbb7ec2c8423d1d3125 Mon Sep 17 00:00:00 2001 From: federico Date: Mon, 6 Sep 2021 19:13:27 +0200 Subject: [PATCH] =?UTF-8?q?ajout=20d'informations=20suppl=C3=A9mentaires?= =?UTF-8?q?=20sur=20le=20Readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ebdde9d..da8ebc6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ # Markdown -Présentation pour Alternatives87 concernant le " langage " Markdown et les éditeurs disponibles pour éditer du markdown. \ No newline at end of file +## Objectif du dépôt. + +Ce dépôt a pour but de centraliser les contributions de toutes et tous afin de produire un manuel de référence, pédagogique, formatif et progressif sur le langage `Markdown`. + +L'objectif initial était de créer une petite documentation rapide pour des collègues de bureau afin qu'ils et elles puissent s'approprier ce langage basique mais relativement puissant pour la prise de notes et la génération de documents simples formatés. + +## Structure du dépôt. + +Pour l'heure le dépôt n'a pas de structure, tout y est mis en vrac. + +## Organisation de la documentation. + +Le document principal de la documentation est appelé actuellement `markdown-le-mini-guide.md`. + + + +## Langages utilisés + +Dans la mesure du possible, parce que justement l'objectif est de montrer la souplesse et la richesse de ce langage, il est voulu de rédiger le contenu du manuel en `markdown`. + +Afin de réaliser un livre à partir du `markdown` j'ai utilisé `pandoc` pour convertir dans cet ordre : `Markdown` → LaTeX → pdf, aussi un fichier ".headers" est inclus afin de modifier certaines entêtes dans le code source en LaTeX et un autre fichier pour être placé dans le corps du document exporté mais avant le code source. + +D'autres versions exportations seront possibles. + +Dans un premier temps ce manuel se voudra en Français, puis, à l'usage se créeront des sous-répertoires où on pourra imaginer des traductions en langues étrangères. + +## Licence. + +Ce manuel se voulant universaliste et une base pour les personnes qui le diffuseront, il est placé dans sa conception et son contenu propre sous licence GPL 2.0 pour l'instant. \ No newline at end of file