Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benbalter/jekyll-readme-index
A Jekyll plugin to render a project's README as the site's index.
https://github.com/benbalter/jekyll-readme-index
github-pages jekyll jekyll-plugin readme ruby
Last synced: 1 day ago
JSON representation
A Jekyll plugin to render a project's README as the site's index.
- Host: GitHub
- URL: https://github.com/benbalter/jekyll-readme-index
- Owner: benbalter
- License: mit
- Created: 2016-09-10T18:24:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-09T06:33:07.000Z (7 months ago)
- Last Synced: 2024-12-03T21:08:39.710Z (9 days ago)
- Topics: github-pages, jekyll, jekyll-plugin, readme, ruby
- Language: Ruby
- Homepage:
- Size: 76.2 KB
- Stars: 90
- Watchers: 6
- Forks: 20
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SECURITY.md
Awesome Lists containing this project
- awesome-jekyll-plugins - **Readme Index** - readme-index](https://rubygems.org/gems/jekyll-readme-index)) by Ben Balter -- render a project's README as the site's index (Settings & Configurations Tweaks)
README
# Jekyll Readme Index
A Jekyll plugin to render a project's README as the site's index.
[](https://travis-ci.org/benbalter/jekyll-readme-index)
## What it does
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.
## Usage
1. Add the following to your Gemfile
```ruby
gem "jekyll-readme-index"
```
2. Add the follow to your site's config
```yml
plugins:
- jekyll-readme-index
```
Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
## Configuration
Configuration options are optional are placed in `_config.yml` under the `readme_index` key. They default to:
```yml
readme_index:
enabled: true
remove_originals: false
with_frontmatter: false
```
### Removing originals
By default the original README markdown files will be included as static pages in the output. To remove them from the output, set the `remove_originals` key to `true`.
### Disabling
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`.