{"id":13612044,"url":"https://github.com/benbalter/jekyll-optional-front-matter","last_synced_at":"2025-04-04T17:09:52.059Z","repository":{"id":47026380,"uuid":"67941301","full_name":"benbalter/jekyll-optional-front-matter","owner":"benbalter","description":"A Jekyll plugin to make front matter optional for Markdown files","archived":false,"fork":false,"pushed_at":"2021-10-31T09:13:08.000Z","size":89,"stargazers_count":83,"open_issues_count":1,"forks_count":27,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-10-09T12:09:39.745Z","etag":null,"topics":["github-pages","jekyll","jekyll-ecosystem","yaml"],"latest_commit_sha":null,"homepage":null,"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},"funding":{"patreon":"benbalter"}},"created_at":"2016-09-11T16:36:39.000Z","updated_at":"2024-09-28T15:12:05.000Z","dependencies_parsed_at":"2022-08-03T00:31:27.468Z","dependency_job_id":null,"html_url":"https://github.com/benbalter/jekyll-optional-front-matter","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-optional-front-matter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fjekyll-optional-front-matter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fjekyll-optional-front-matter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fjekyll-optional-front-matter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benbalter","download_url":"https://codeload.github.com/benbalter/jekyll-optional-front-matter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247217222,"owners_count":20903009,"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-ecosystem","yaml"],"created_at":"2024-08-01T20:00:21.583Z","updated_at":"2025-04-04T17:09:52.036Z","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 Optional Front Matter\n\nA Jekyll plugin to make front matter optional for Markdown files\n\n[![CI](https://github.com/benbalter/jekyll-optional-front-matter/actions/workflows/ci.yml/badge.svg)](https://github.com/benbalter/jekyll-optional-front-matter/actions/workflows/ci.yml)\n\n## What it does\n\nOut of the box, Jekyll requires that any markdown file have YAML front matter (key/value pairs separated by two sets of three dashes) in order to be processed and converted to HTML.\n\nWhile that behavior may be helpful for large, complex sites, sometimes it's easier to simply add a plain markdown file and have it render without fanfare.\n\nThis plugin does just that. Any Markdown file in your site's source will be treated as a Page and rendered as HTML, even if it doesn't have YAML front matter.\n\n## Usage\n\n1. Add the following to your site's Gemfile:\n    ```ruby\n    group :jekyll_plugins do\n      gem 'jekyll-optional-front-matter'\n    end\n    ```\n2. Install the plugin.\n    - Using Bundler.\n        ```bash\n        $ bundler install\n        ```\n    - Using Gem.\n        ```bash\n        $ # Install in your user's home directory.\n        $ gem install jekyll-optional-front-matter --user-install\n        $ # Install for root user.\n        $ sudo gem install jekyll-optional-front-matter\n        ```\n3. Add the following to your site's config file:\n    ```yml\n    plugins:\n      - jekyll-optional-front-matter\n    ```\n\nNote: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.\n\n## One potential gotcha\n\nIn order to preserve backwards compatibility, the plugin does not recognize [a short list of common meta files](https://github.com/benbalter/jekyll-optional-front-matter/blob/master/lib/jekyll-optional-front-matter.rb#L4).\n\nIf you want Markdown files like your README, CONTRIBUTING file, CODE_OF_CONDUCT, or LICENSE, etc., you'll need to explicitly add YAML front matter to the file, or add it to your config's list of `include` files, e.g.:\n\n```yml\ninclude:\n  - CONTRIBUTING.md\n  - README.md\n```\n\n## Configuration\nYou can configure this plugin in `_config.yml` by adding to the `optional_front_matter` key.\n\n### Removing originals\n\nBy default the original 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```yml\noptional_front_matter:\n  remove_originals: true\n```\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 adding the following to your site's config:\n\n```yml\noptional_front_matter:\n  enabled: false\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbalter%2Fjekyll-optional-front-matter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenbalter%2Fjekyll-optional-front-matter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbalter%2Fjekyll-optional-front-matter/lists"}