language - Github: ¿Cómo incrustar una esencia en README.md?

markdown tutorial

Question

¿Es posible incrustar gits en el archivo README.md que reside en un repositorio github?

Algo como:

<code id="gist-3167145"></code>

Answer 1

Actualización: mi respuesta funciona con páginas github, compiladas a través de jekyll. Utilizo las etiquetas de script en el descuento que luego es procesado por jekyll.

Como markdown es compatible con html, uno simplemente puede usar la etiqueta <script> para incrustar gist.

Simplemente copie la url incrustada de la esencia proporcionada por github

..y pegarlo en tu archivo de descuento.

Ejemplo: Copie lo siguiente y pegue en su archivo de reducción.

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

..y esto es lo que obtendrás

Answer 2

Esto se puede hacer en 2017 cuando se usan las páginas de GitHub y un tema de Jekyll:

Ver https://gist.github.com/benbalter/5555251 desde @benbalter

Simple como: {% gist 123456789 %}

Answer 3

No, lo siento, eso no es posible. Deberá tener un enlace en su archivo README.md o copiar sus contenidos.

Github Flavored Markdown le mostrará lo que puede poner en su archivo README.md.

Answer 4

Puede hacerlo si está usando un preprocesador de Gitdown tal como 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);
});
});
});
}
});

Luego, en su rebaja, haría referencia al Gist usando un gancho JSON, por ej.

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

Esta característica debería convertirse en parte de Gitdown en un futuro cercano (hay un problema abierto, https://github.com/gajus/gitdown/issues/7 ).