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
99.99% Uptime for MySQL and PostgreSQL on Google Cloud
Cloud SQL Enterprise Plus gives you a 99.99% availability SLA with near-zero downtime maintenance—typically under 10 seconds. Get 2x better read/write performance, intelligent data caching, and 35 days of point-in-time recovery. Supports MySQL, PostgreSQL, and SQL Server with built-in vector search for gen AI apps. New customers get $300 in free credit.
Rate This Project
Login To Rate This Project
User Reviews
Be the first to post a review of Jekyll Readme Index!
