LinkSearchMenuExpandDocument
Table of contents

Jekyll-gist

Gem Version  GitHub Pages Supported

Tags: , , ,

JekyllサイトでGitHub Gistsを表示するためのLiquidタグ

インストール

  1. Gemfileを編集

    # Gemfile
    group :jekyll_plugins do
      gem 'jekyll-gist'
    end
    
  2. _config.ymlを編集

    # _config.yml
    plugins:
      - jekyll-gist
    
  3. Pluginのインストール

    bundle
    

使い方

Jekyllのページや投稿、コレクションで以下のようにLiquidタグの後に gist_idを指定します。

{% gist c08ee0f2726fd0e3909d %}

これで、関連する<script>タグが作成されます。

<script src="https://gist.github.com/parkr/c08ee0f2726fd0e3909d.js"> </script>

オプションでファイル名を指定できます。

{% gist c08ee0f2726fd0e3909d test.md %}

これにより、Gist全体ではなく指定したファイルだけを投稿に表示するための 正しいURLが生成されます。

Tips

環境変数JEKYLL_GITHUB_TOKENとしてアクセストークンを提供すると、 Jekyll GistはGist APIを使用してサイト生成を高速化します。

noscriptサポートの無効化

デフォルトでは、Jekyll GistはGistごとにHTTP呼び出しを行い、 Gistのコンテンツを取得します。 この情報は、JavaScriptをサポートしていない検索エンジンやブラウザのために <noscript> タグを生成するために使用されます。 この機能を無効にしたい場合、例えばビルドを高速化したい場合は、 サイトの_config.ymlに以下を追加してください。

# _config.yml
gist:
  noscript: false

ブログ記事

下記に掲載を希望される方はご連絡ください (詳細)

Back to top


Back to top

Copyright © 2021 Otti

Page last modified: