Github: Comment intégrer un résumé de l'information dans le fichier README.md?

Mise à jour : Ma réponse travaille avec github pages, construits par l'intermédiaire de jekyll. J'utilise les balises de script dans markdown qui est ensuite traité par jekyll.

Depuis markdown prend en charge le html, on peut simplement utiliser la <script> étiquette à intégrer les gist.

Il suffit de copier le embed url de l'essentiel de l'information fournie par github

..et le coller dans vous démarque de fichier.

Exemple : Copie ci-dessous et collez-le dans votre fichier markdown.

<script src="https://gist.github.com/nisrulz/11c0d63428b108f10c83.js"></script>

..et c'est ce que vous obtiendrez

Vous pouvez le faire si vous utilisez un abattement de préprocesseur comme Gitdown:

/**
* Resolve Gist (https://gist.github.com/)
*
* @param {Object} config
* @param {String} config.id Gist ID.
* @param {String} config.fileName Gist file name. Default to gistfile1.txt.
*/
gitdown.registerHelper('gist', {
compile: function (config) {
config = config || {};
config.fileName = config.fileName || 'gistfile1.txt';
if (!config.id) {
throw new Error('Gist ID must be provided.');
}
return new Promise(function (resolve) {
var https = require('https');
https.get({
host: 'api.github.com',
path: '/gists/' + config.id,
headers: {
//User agent is required to communicate with Github API.
'user-agent': 'Gitdown – gist'
}
}, function(res) {
var body = '';
res.setEncoding('utf8');
res.on('data', function (d) {
body += d;
});
res.on('end', function () {
var gist = JSON.parse(body);
if (!gist.files) {
throw new Error('Gist ("' + config.id + '") not found.');
}
if (!gist.files[config.fileName]) {
throw new Error('File ("' + config.fileName + '") is not part of the gist ("' + config.id + '").');
}
resolve(gist.files['gistfile1.txt'].content);
});
});
});
}
});

Puis dans votre markdown votre serait de référence de l'essence à l'aide d'un JSON crochet, par exemple

{"gitdown": "gist", "id": "d3e4212c799252bac5fa"}

Cette fonctionnalité devrait devenir une partie intégrante de la Gitdown dans un futur proche (il y a un problème, https://github.com/gajus/gitdown/issues/7).