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
Our Free Plans just got better! | Auth0
You asked, we delivered! Auth0 is excited to expand our Free and Paid plans to include more options so you can focus on building, deploying, and scaling applications without having to worry about your security. Auth0 now, thank yourself later.
Rate This Project
Login To Rate This Project
User Reviews
Be the first to post a review of Jekyll Readme Index!
