{"id":18565312,"url":"https://github.com/pelican-plugins/yaml-metadata","last_synced_at":"2025-04-10T04:32:45.976Z","repository":{"id":173698634,"uuid":"650945683","full_name":"pelican-plugins/yaml-metadata","owner":"pelican-plugins","description":"Pelican plugin for YAML-formatted Markdown metadata headers","archived":false,"fork":false,"pushed_at":"2024-04-19T14:17:32.000Z","size":44,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-01T20:03:45.773Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pypi.org/project/pelican-yaml-metadata/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pelican-plugins.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-08T06:43:14.000Z","updated_at":"2024-02-05T00:17:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"c6ed9efc-f0ac-40c7-bcdc-30aaaf8dd21e","html_url":"https://github.com/pelican-plugins/yaml-metadata","commit_stats":null,"previous_names":["pelican-plugins/yaml-metadata"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fyaml-metadata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fyaml-metadata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fyaml-metadata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fyaml-metadata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pelican-plugins","download_url":"https://codeload.github.com/pelican-plugins/yaml-metadata/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248157650,"owners_count":21057047,"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":[],"created_at":"2024-11-06T22:18:28.987Z","updated_at":"2025-04-10T04:32:45.648Z","avatar_url":"https://github.com/pelican-plugins.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Pelican YAML Metadata\n=====================\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/yaml-metadata/main.yml?branch=main)](https://github.com/pelican-plugins/yaml-metadata/actions)\n[![PyPI Version](https://img.shields.io/pypi/v/pelican-yaml-metadata)](https://pypi.org/project/pelican-yaml-metadata/)\n![License](https://img.shields.io/pypi/l/pelican-yaml-metadata?color=blue)\n\nThis [Pelican](https://github.com/getpelican/pelican) plugin allows articles written in Markdown to\ndefine their metadata using a [YAML](https://en.wikipedia.org/wiki/YAML) header. This format is\ncompatible with other popular static site generators like [Jekyll](https://jekyllrb.com/) or\n[Hugo](https://gohugo.io/).\n\nIt is fully backwards-compatible with the default metadata parsing.\n\nInstallation\n------------\nThis plugin can be installed via:\n\n    python -m pip install pelican-yaml-metadata\n\nAs long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `yaml_metadata` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.\n\nUsage\n-----\nThis plugin aims to keep things simple. After installing and enabling it, any Markdown files will\nhave the option of defining metadata using a YAML header instead of the standard key/value pairs.\n\nIn order to specify metadata using YAML, enclose it within `---` lines.\n\nExample:\n```yaml\n---\ntitle: Some title\nauthor: Some person\ntags:\n  - tag 1\n  - tag 2\ndate: 2014-12-25 00:00\nsummary: The article summary will be __parsed__ as markdown\n---\n\nThis is some article text.\n```\n\nIf the YAML block is not found, the metadata will be parsed using the normal Markdown metadata\nsyntax.\n\nContributing\n------------\nContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on [existing issues][].\n\nTo start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.\n\n[existing issues]: https://github.com/pelican-plugins/yaml-metadata/issues\n[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html\n\nLicense\n-------\nThis project is licensed under the [MIT license](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpelican-plugins%2Fyaml-metadata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpelican-plugins%2Fyaml-metadata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpelican-plugins%2Fyaml-metadata/lists"}