51

是否可以将要点嵌入到位于 GitHub 存储库中的 README.md 文件中？

就像是：

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

5 回答 5

30

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

Github Flavored Markdown将向您展示可以放入 README.md 文件中的内容。

于 2012-07-24T00:54:22.593 回答
26

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

由于 Markdown 支持 html，因此可以简单地使用<script>标签来嵌入 gist。

只需复制github提供的gist的embed url

在此处输入图像描述

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

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

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

..这就是你会得到的

在此处输入图像描述

于 2015-08-16T01:22:45.033 回答
4

如果您使用的是诸如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）。

于 2014-11-22T16:39:24.930 回答
3

当使用GitHub Pages和 Jekyll 主题时，这在 2017 年是可行的：

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

简单如：{% gist 123456789 %}

于 2017-08-22T19:02:35.050 回答
0

有些人最终会来到这里，因为他们想使用自动生成的 gists 来使他们在 github 上的个人资料更加有趣，包括活动框、生产框等（这些东西的列表）。但是，您应该注意，这些自动生成的要点不应添加到您的个人资料专用 README 文件中，而应使用个人资料页面上的“自定义您的 pin ”选项固定。

于 2021-10-04T23:41:11.473 回答