Question

是否可以将gits嵌入驻留在github存储库中的README.md文件中？

类似的东西：

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

Answer 1

不，对不起，这是不可能的。您必须在README.md中找到指向它的链接或复制其内容。

Github Flavored Markdown将向您显示您可以在README.md文件中添加的内容。

Answer 2

更新：我的回答适用于通过jekyll构建的github页面。我在markdown中使用脚本标签，然后由jekyll处理。

由于markdown支持html，因此可以使用 <script> 标记来嵌入gist。

只需复制github

提供的要点的嵌入网址即可

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

示例：复制以下内容并粘贴到markdown文件中。

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

..这就是你将得到的

Answer 3

如果您使用的是降价预处理器，例如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);
                });
            });
        });
    }
});

然后在你的降价中你会使用JSON钩子引用Gist，例如

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

此功能应该在不久的将来成为Gitdown的一部分（有一个未解决的问题，https://github.com/gajus/gitdown/issues/7）。

Answer 4

2017年使用 GitHub Pages 和Jekyll主题时可以这样做：

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

中的@benbalter

简单如：{% gist 123456789 %}

Github：如何在README.md中嵌入一个要点？

4 个答案: