Github:如何在README.md中embedded一个要点?

是否有可能embedded到README.md文件驻留在github回购?

就像是:

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

更新:我的答案适用于通过jekyll构build的github页面。 我在markdown中使用脚本标记,然后由jekyll处理。

由于markdown支持html,所以可以简单地使用<script>标签来embedded要点。

只需复制github提供的要点的embeddedURL

在这里输入图像说明

..并将其粘贴到您的降价文件。

示例:复制下面的内容并粘贴到您的降价文件中。

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

..这是你将得到的

在这里输入图像说明

不,对不起,这是不可能的。 您将不得不在您的README.md中链接到它或复制其内容。

Github Flavored Markdown会告诉你你可以放在你的README.md文件中。

如果您使用诸如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); }); }); }); } }); 

然后在你的markdown你会引用Gist使用JSON钩子,例如

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

这个function应该在不久的将来成为Gitdown的一部分(有一个公开的问题, https://github.com/gajus/gitdown/issues/7 )。

这是可以在2017年使用GitHub页面和一个Jekyll主题:

请参阅@benbalter的 https://gist.github.com/benbalter/5555251

很简单: {% gist 123456789 %}