Table of contents

Jekyll-titles-from-headings

ページタイトルが指定されていない時、最初のMarkdown見出しをタイトルに指定するすJekyllプラグイン

このプラグインは、JekyllページのYAML Front Matterでタイトルが指定されていなく、ページ内の最初の非空白行がMarkdownのH1/H2/H3である場合、 Jekyllにその最初の見出しをページのタイトルとして使用するよう指示します。

インストール

Gemfileを編集

# Gemfile
group :jekyll_plugins do
  gem 'jekyll-titles-from-headings'
end

_config.ymlを編集

# _config.yml
plugins:
  - jekyll-titles-from-headings

デフォルトは以下のとおりです。

# _config.yml
titles_from_headings:
  enabled:     true
  strip_title: false
  collections: false

テーマがpage.titleに基づいてタイトルをレンダリングする場合、タイトルを二度レンダリングしないようにstrip_titleを設定することで、コンテンツからタイトルを削除することができます。

この動作を特定のレイアウトやパスに限定するには、 Front Matterのデフォルト設定を行います。

# _config.yml
defaults:
  - scope:
      path: some-path
      layout: some_layout
    values:
      strip_title: true

コレクションアイテムに対してプラグインを有効にしたい場合、 collectionsオプションをtrueに設定します。

コレクションアイテム (投稿を含む) はファイル名から推測してタイトルを持っています。このオプションは推測されるタイトルを上書きするように、このプラグインの動作を変更します。推測されるタイトルは、ドキュメントが見出しで始まらない場合の予備としてのみ使用されます。

プラグインが有効になっていても (例えばGemfileの:jekyll_pluginsグループで)、 enabledキーをfalseに設定することで無効化できます。

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