{"id":13474696,"url":"https://github.com/benbalter/jekyll-readme-index","last_synced_at":"2025-04-04T06:08:17.325Z","repository":{"id":52608594,"uuid":"67887394","full_name":"benbalter/jekyll-readme-index","owner":"benbalter","description":"A Jekyll plugin to render a project's README as the site's index.","archived":false,"fork":false,"pushed_at":"2024-05-09T06:33:07.000Z","size":78,"stargazers_count":91,"open_issues_count":6,"forks_count":20,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-28T05:09:29.359Z","etag":null,"topics":["github-pages","jekyll","jekyll-plugin","readme","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benbalter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":".github/funding.yml","license":"LICENSE.md","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"docs/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"benbalter"}},"created_at":"2016-09-10T18:24:10.000Z","updated_at":"2025-02-05T11:26:28.000Z","dependencies_parsed_at":"2024-01-14T04:48:34.053Z","dependency_job_id":"467596ea-e5f2-49fd-a92d-1401392da026","html_url":"https://github.com/benbalter/jekyll-readme-index","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fjekyll-readme-index","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fjekyll-readme-index/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fjekyll-readme-index/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fjekyll-readme-index/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benbalter","download_url":"https://codeload.github.com/benbalter/jekyll-readme-index/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128744,"owners_count":20888235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-pages","jekyll","jekyll-plugin","readme","ruby"],"created_at":"2024-07-31T16:01:14.134Z","updated_at":"2025-04-04T06:08:17.308Z","avatar_url":"https://github.com/benbalter.png","language":"Ruby","funding_links":["https://patreon.com/benbalter"],"categories":["Settings \u0026 Configurations Tweaks","Ruby"],"sub_categories":[],"readme":"# Jekyll Readme Index\n\nA Jekyll plugin to render a project's README as the site's index.\n\n[![Build Status](https://travis-ci.org/benbalter/jekyll-readme-index.svg?branch=master)](https://travis-ci.org/benbalter/jekyll-readme-index)\n\n## What it does\n\nLet'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?\n\nIf 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.\n\n## Usage\n\n1. Add the following to your Gemfile\n\n  ```ruby\n  gem \"jekyll-readme-index\"\n  ```\n\n2. Add the follow to your site's config\n\n  ```yml\n  plugins:\n    - jekyll-readme-index\n  ```\n  Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.\n\n## Configuration\n\nConfiguration options are optional are placed in `_config.yml` under the `readme_index` key. They default to:\n\n```yml\nreadme_index:\n  enabled:          true\n  remove_originals: false\n  with_frontmatter: false\n```\n\n### Removing originals\n\nBy 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`.\n\n### Disabling\n\nEven 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`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbalter%2Fjekyll-readme-index","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenbalter%2Fjekyll-readme-index","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbalter%2Fjekyll-readme-index/lists"}