{"id":18099372,"url":"https://github.com/butler54/mdformat-frontmatter","last_synced_at":"2026-05-23T07:00:42.129Z","repository":{"id":49772980,"uuid":"338473098","full_name":"butler54/mdformat-frontmatter","owner":"butler54","description":"mdformat plugin to ensure frontmatter is respected.","archived":false,"fork":false,"pushed_at":"2026-05-23T05:14:13.000Z","size":94,"stargazers_count":16,"open_issues_count":4,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-05-23T05:22:04.697Z","etag":null,"topics":["mdformat","pypi"],"latest_commit_sha":null,"homepage":"","language":"Python","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/butler54.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-02-13T01:26:29.000Z","updated_at":"2026-05-23T05:14:16.000Z","dependencies_parsed_at":"2025-04-13T15:55:40.575Z","dependency_job_id":"b9aaa2e0-948d-4817-8dc0-aa6c9956fea0","html_url":"https://github.com/butler54/mdformat-frontmatter","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":"executablebooks/mdformat-plugin","purl":"pkg:github/butler54/mdformat-frontmatter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butler54%2Fmdformat-frontmatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butler54%2Fmdformat-frontmatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butler54%2Fmdformat-frontmatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butler54%2Fmdformat-frontmatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/butler54","download_url":"https://codeload.github.com/butler54/mdformat-frontmatter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/butler54%2Fmdformat-frontmatter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33386076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-23T04:15:53.637Z","status":"ssl_error","status_checked_at":"2026-05-23T04:15:53.242Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["mdformat","pypi"],"created_at":"2024-10-31T21:08:11.669Z","updated_at":"2026-05-23T07:00:42.122Z","avatar_url":"https://github.com/butler54.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mdformat-frontmatter\n\n[![Build Status][ci-badge]][ci-link]\n[![codecov.io][cov-badge]][cov-link]\n[![PyPI version][pypi-badge]][pypi-link]\n[![OpenSSF Scorecard][scorecard-badge]][scorecard-link]\n\nAn [mdformat](https://github.com/executablebooks/mdformat) plugin for ensuring that yaml `front-matter` is respected.\nMany tools (such as [jekyll](https://github.com/jekyll/jekyll)) use yaml front matter for automation purposes.\n`mdformat-frontmatter` only supports yaml. For example:\n\n```markdown\n\n---\ntest: yaml\n---\n# This looks okay\nFor some markdown code.\n```\n\nFrontmatter can only be at the first line or two of the code.\n```markdown\n# This is not\n---\ntest: yaml\n---\n```\nNote: that at this stage this plugin is not that sophisticated. The principle objective is to allow properly formed yaml header blocks to pass through.\nIncorrectly formed blocks may result in strange behaviour.\n\n## Requirements\n\nPython 3.10 or higher.\n\n## Development\n\nThis package was built from the [template](https://github.com/executablebooks/mdformat-plugin) provided by [executable books](https://github.com/executablebooks) and customized (specifically to separate content PR's from the release cycle).\nThis package uses [hatch](https://hatch.pypa.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.\n\nTo install development dependencies:\n\n```bash\npip install -e \".[dev,test]\"\n```\n\nTo run the tests:\n\n```bash\ntox\n```\n\nand with test coverage:\n\n```bash\ntox -e py312-cov\n```\n\nThe easiest way to write tests, is to edit tests/fixtures.md\n\nTo run the code formatting and style checks:\n\n```bash\ntox -e py312-pre-commit\n```\n\nor directly\n\n```bash\npip install pre-commit\npre-commit run --all\n```\n\nTo run the pre-commit hook test:\n\n```bash\ntox -e py312-hook\n```\n\n## Release Process\n\nReleases are fully automated using [python-semantic-release](https://python-semantic-release.readthedocs.io/) and [conventional commits](https://www.conventionalcommits.org/):\n\n1. Merge PRs with conventional commit titles (e.g., `fix:`, `feat:`, `chore:`)\n2. The CI workflow automatically analyzes commits, determines version bump, updates CHANGELOG, creates a tag, and publishes to PyPI\n3. Artifacts are signed with [Sigstore](https://www.sigstore.dev/) for supply chain security\n\nThe release workflow uses [PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC) and generates [attestations](https://docs.pypi.org/attestations/) for all published packages.\n\n[ci-badge]: https://github.com/butler54/mdformat-frontmatter/workflows/CI/badge.svg?branch=main\n[ci-link]: https://github.com/butler54/mdformat-frontmatter/actions?query=workflow%3ACI+branch%3Amain+event%3Apush\n[cov-badge]: https://codecov.io/gh/butler54/mdformat-frontmatter/branch/main/graph/badge.svg\n[cov-link]: https://codecov.io/gh/butler54/mdformat-frontmatter\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-frontmatter.svg\n[pypi-link]: https://pypi.org/project/mdformat-frontmatter\n[scorecard-badge]: https://api.scorecard.dev/projects/github.com/butler54/mdformat-frontmatter/badge\n[scorecard-link]: https://scorecard.dev/viewer/?uri=github.com/butler54/mdformat-frontmatter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbutler54%2Fmdformat-frontmatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbutler54%2Fmdformat-frontmatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbutler54%2Fmdformat-frontmatter/lists"}