Registry / other / jekyll-readme-index

jekyll-readme-index

JSON →
library0.3.0rbrubygemsunverified

A Jekyll plugin to render a project's README as the site's index.

gem install jekyll-readme-index
INSTALL
IMPORT
SIG · JEKYLL-README-INDE
J
jekyll-readme-index
otherrubyv0.3.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

JekyllReadmeIndex
require 'jekyll-readme-index'

Enable the plugin in Jekyll configuration

require 'jekyll-readme-index' # In _config.yml: # plugins: # - jekyll-readme-index # Then ensure README.md exists in the root of your Jekyll site.
Debug
Known issues

No known issues recorded.

Upgrade
Version history
0.3.0latest on RubyGems
Audit
Dependencies

No dependency data recorded yet.

Agent activity
6 hits · last 30 days
node
6
Resources
jekyll-readme-index — gem install jekyll-readme-index · libregistry