Github: Как внедрить суть в README.md?

Question

Можно ли вставить gits в файл README.md, который находится в репозитории github?

Что-то вроде:

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

Answer 1

Обновление: мой ответ работает со страницами github, созданными с помощью jekyll. Я использую теги script в уценке, которая затем обрабатывается jekyll.

Поскольку уценка поддерживает HTML, можно просто использовать <script> тег для встраивания сущности.

Просто скопируйте встроенный URL-адрес GIST, предоставленный GitHub

..и вставьте его в файл уценки.

Пример: скопируйте ниже и вставьте в ваш файл уценки.

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

..и это то, что вы получите

Answer 2

Нет, извините, это невозможно. Вам нужно будет либо иметь ссылку на него в вашем README.md, либо скопировать его содержимое.

Github Flavored Markdown покажет вам, что вы можете поместить в файл README.md.

Answer 3

Это выполнимо в 2017 году при использовании GitHub Pages и темы Jekyll:

См. https://gist.github.com/benbalter/5555251 от @benbalter.

Просто как: {% gist 123456789 %}

Answer 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);
                });
            });
        });
    }
});

Затем в вашей уценке вы бы ссылались на Gist с помощью JSON-хука, например

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

Эта функция должна стать частью Gitdown в ближайшем будущем (есть открытый вопрос, https://github.com/gajus/gitdown/issues/7).

Answer 5

Некоторые люди попадают сюда из-за того, что они хотят использовать автоматически сгенерированные gists, чтобы сделать свой профиль на github более интересным с помощью окна активности, продуктивного окна и т. Д. (Список этого материала). Тем не менее, вы должны отметить, что эти автоматически сгенерированные gists не должны добавляться в специальный файл README вашего профиля, а должны быть закреплены с помощью параметра « Настроить ваши контакты » на странице вашего профиля.