Qu'est-ce qu'un fichier "format Markdown" README sur Github?
Je ne sais pas quel est le format, s'il y a des exigences systématiques/en ligne de commande pour le créer, etc.
Fondamentalement, il suffit de connaître les spécifications et s'il existe des étapes techniques pour générer le fichier README.
Markdown est une syntaxe simple pour fournir des informations sémantiques et représenter une mise en forme courante en texte brut. Daring Fireball a un impressionnant guide de syntaxe pour démarque standard . GitHub utilise ensuite une variante de ce qu'ils appellent GitHub Flavored Markdown .
Pour configurer votre fichier lisez-moi, créez simplement un fichier texte et nommez-le README (ou README.md/README.markdown) et validez-le à la racine de votre dépôt. GitHub le récupérera ensuite comme le readme du projet.
Wikipedia - Markdown fait référence à la page "GitHub Flavored Markdown - Introduction" ( archv. )
Citation de la page:
GitHub utilise ce que nous appelons "GitHub Flavored Markdown" (GFM) pour les messages, les problèmes et les commentaires. Il diffère du Markdown (SM) standard de plusieurs manières importantes et ajoute des fonctionnalités supplémentaires.
La page donne également une description des différences avec Markdown standard.
Il y a aussi plus d'informations sur la façon dont Markdown est réellement rendu par GitHub:
Si vous êtes intéressé par la façon dont nous rendons les fichiers Markdown, vous voudrez peut-être consulter Redcarpet , notre interface Ruby avec la bibliothèque Sundown .
(Apparemment, Sundown est le véritable analyseur Markdown utilisé derrière les rideaux.)
Pour ajouter une couche d'abstraction supplémentaire, Sundown est une fourchette d'un autre analyseur Markdown :-)
Citation de page GitHub de Sundown :
Sundown est un analyseur Markdown basé sur le code original de la bibliothèque pskirt de Natacha Porté.
C'est très étrange, mais il semble que GitHub n'utilise pas GitHub-Flavored Markdown (GFM) lors du rendu d'un fichier README.
GitHub utilise "GitHub Flavored Markdown" ou GFM, sur l'ensemble du site - dans les problèmes, les commentaires et les demandes de tirage.
Au lieu de cela, il semble utiliser une version appelée redcarpet dans le cadre du projet de balisage GitHub . Ils prennent également en charge plusieurs autres formats de balisage, notamment MediaWiki. Utilisez simplement la bonne extension de fichier et GitHub rendra le balisage.
Si vous voulez voir les différences entre les deux versions différentes de Markdown, lisez les description de GFM et ses fonctionnalités supplémentaires .