L'extension ".md" désigne la syntaxe "Markdown" pour l'écriture de la documentation. Contrairement à d'autres syntaxes de wiki, cette syntaxe est suffisamment claire pour que le fichier soit lisible dans son format brut , c'est à dire sans l'aide d'un viewer.
Nous pouvons ainsi rédiger la documentation de notre projet à l'aide de fichier ".md" qui seront inclus dans les sources du projet. Nous n'avons pas ainsi besoin d'utiliser le wiki de Github qui lui reste au niveau de Github.
La syntaxe est décrite dans cette page : http://daringfireball.net/projects/markdown/syntax
Il nous est possible de faire des liens entre les fichiers ".md" à l'aide de liens relatifs. Nous pouvons également insérer des images en déposant ces images dans un sous-répertoire et en indiquant un lien relatif vers ce sous-répertoire depuis le fichier ".md".
La syntaxe "Markdown" permet d'avoir une documentation simple, portable dans un projet et lisible sans l'aide d'un viewer.
Plugin de visualisation pour eclipse
Il existe un plugin pour eclipse qui permet de visualiser le rendu d'un fichier ".md".Ce plugin se nomme "Github Flavored Markdown viewer plugin".
Voir : https://marketplace.eclipse.org/content/github-flavored-markdown-viewer-plugin-eclipse
Après installation, la visualisation d'un fichier ".md" se fait dans une nouvelle vue nommée "GFM View".
Cette vue contient le rendu du fichier tel qui le sera sur Github.
1 commentaire:
Merci pour ce lien !
Une petite chose à savoir.
Le plugin utilise l'API Github pour fournir le rendu de la page. Si vous n'êtes pas authentifié, vous serez limité à 60 requêtes / heure. (http://developer.github.com/v3/#rate-limiting)
A la place du rendu, vous obtiendrez un message du type :
{"message":"API rate limit exceeded for 194.168.113.276. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)","documentation_url":"http://developer.github.com/v3/#rate-limiting"}
Enregistrer un commentaire