ajout d'informations supplémentaires sur le Readme
This commit is contained in:
parent
6816baf737
commit
d338d3adb5
30
README.md
30
README.md
@ -1,3 +1,31 @@
|
||||
# Markdown
|
||||
|
||||
Présentation pour Alternatives87 concernant le " langage " Markdown et les éditeurs disponibles pour éditer du markdown.
|
||||
## 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.
|
Loading…
Reference in New Issue
Block a user