Download
A Jekyll plugin to render a project's README as the site's index. Let's say you have a GitHub repository with a README.md file, that you'd like to use as the index (main page) for a GitHub Pages site. You could rename the file to index.md, but then it wouldn't render on GitHub.com. You could add YAML front matter with permalink: / to the README, but why force a human to do what Jekyll can automate? If you have a readme file, and your site doesn't otherwise have an index file, this plugin instructs Jekyll to use the readme as the site's index. That's it, no more, no less.
Features
- Jekyll plugin to render a project's README as the site's index
- By default the original README markdown files will be included as static pages in the output
- Even if the plugin is enabled (e.g., via the :jekyll_plugins group in your Gemfile) you can disable it by setting the enabled key to false
- Configuration options are optional are placed in _config.yml under the readme_index key
- This plugin instructs Jekyll to use the readme as the site's index
Project Samples
Categories
Web DesignLicense
MIT LicenseFollow Jekyll Readme Index
Other Useful Business Software
AI-generated apps that pass security review
Retool lets you generate dashboards, admin panels, and workflows directly on your data. Type something like “Build me a revenue dashboard on my Stripe data” and get a working app with security, permissions, and compliance built in from day one. Whether on our cloud or self-hosted, create the internal software your team needs without compromising enterprise standards or control.
Rate This Project
Login To Rate This Project
User Reviews
Be the first to post a review of Jekyll Readme Index!
