Jekyll-readme-index

Tags: gem-based-plugins , github-pages , index , readme

プロジェクトのREADMEをサイトのインデックスとして表示するJekyllプラグイン

• Homepage (github.com) [EN]

プロジェクトのREADMEをサイトのインデックスとして表示するJekyllプラグイン

readmeファイルがあり、サイトにインデックスファイルがない場合、 このプラグインはJekyllにreadmeをサイトのインデックスとして使うように指示します。

インストール

1. Gemfileを編集

   # Gemfile
   group :jekyll_plugins do
     gem 'jekyll-readme-index'
   end
   

2. _config.ymlを編集

   # _config.yml
   plugins:
     - jekyll-readme-index
   

3. Pluginのインストール

   bundle
   

設定

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

# _config.yml
readme_index:
  enabled:          true
  remove_originals: false
  with_frontmatter: false

ブログ記事

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

Back to top