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
You Might Also Like
MongoDB Atlas runs apps anywhere
MongoDB Atlas gives you the freedom to build and run modern applications anywhere—across AWS, Azure, and Google Cloud. With global availability in over 115 regions, Atlas lets you deploy close to your users, meet compliance needs, and scale with confidence across any geography.
Rate This Project
Login To Rate This Project
User Reviews
Be the first to post a review of Jekyll Readme Index!