A Jekyll plugin to render a project's README as the site's index.
Overview
The Jekyll Readme Index plugin offers a seamless solution for GitHub repository owners looking to utilize their README.md file as the main page of their GitHub Pages site. Instead of the manual labor involved in renaming files or adding YAML front matter, this plugin automates the process, making it easier than ever to showcase your project’s details right from the README. By following GitHub conventions, it integrates naturally into existing workflows, making site setup straightforward and efficient.
Designed to work effortlessly with Jekyll, this plugin narrows down the complexity of website management, allowing developers to focus more on content creation and less on technical configurations. With customizable options and built-in flexibility, it serves as a valuable tool for anyone managing a project on GitHub.
Features
- Automatic Indexing: Instructs Jekyll to use the README file as the site’s index, eliminating the need for manual file renames.
- Multiple README Support: Supports multiple README locations (.github/README.md, README.md, docs/README.md) and prioritizes them according to GitHub’s conventions.
- Custom README Patterns: Allows customization of the README detection pattern through the readme_pattern configuration option, facilitating greater flexibility for unique project setups.
- Static Page Management: By default, original README files are included as static pages, but you can easily configure it to remove them from the output.
- Disable Plugin Functionality: Even with the plugin enabled, you have the option to disable it at any time through configuration settings.
- Compatibility: Works with Jekyll environments up to version 3.5.0 and provides necessary adjustments for older versions, ensuring broad usability across different setups.
