Skip to content

Commit 34f2544

Browse files
committed
feat!: support mdformat v1
1 parent 1c249d3 commit 34f2544

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Answer file maintained by Copier for: https://github.com/KyleKing/mdformat-plugin-template
33
# DO NOT MODIFY THIS FILE. Edit by re-running copier and changing responses to the questions
44
# Check into version control.
5-
_commit: 2.4.3
5+
_commit: 2.4.4
66
_src_path: gh:KyleKing/mdformat-plugin-template
77
author_email: [email protected]
88
author_name: Kyle King

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Add this package wherever you use `mdformat` and the plugin will be auto-recogni
3939
- [mdformat-black](https://pypi.org/project/mdformat-black)
4040
- [mdformat-config](https://pypi.org/project/mdformat-config)
4141
- [mdformat-footnote](https://pypi.org/project/mdformat-footnote)
42-
- [mdformat-frontmatter](https://pypi.org/project/mdformat-frontmatter)
42+
- [mdformat-front-matters](https://pypi.org/project/mdformat-front-matters) (previously [mdformat-frontmatter](https://pypi.org/project/mdformat-frontmatter))
4343
- [mdformat-simple-breaks](https://pypi.org/project/mdformat-simple-breaks)
4444
- [mdformat-web](https://pypi.org/project/mdformat-web)
4545
- [mdformat-wikilink](https://github.com/tmr232/mdformat-wikilink)
@@ -49,7 +49,7 @@ Add this package wherever you use `mdformat` and the plugin will be auto-recogni
4949
```yaml
5050
repos:
5151
- repo: https://github.com/executablebooks/mdformat
52-
rev: 0.7.19
52+
rev: 1.0.0
5353
hooks:
5454
- id: mdformat
5555
additional_dependencies:
@@ -58,17 +58,17 @@ repos:
5858
# - "mdformat-mkdocs[recommended]"
5959
```
6060

61-
### pipx/uv
61+
### uvx
6262

6363
```sh
64-
pipx install mdformat
65-
pipx inject mdformat mdformat-mkdocs
64+
uvx --with mdformat-mkdocs mdformat
6665
```
6766

68-
Or with uv:
67+
Or with pipx:
6968

7069
```sh
71-
uv tool run --from mdformat-mkdocs mdformat
70+
pipx install mdformat
71+
pipx inject mdformat mdformat-mkdocs
7272
```
7373

7474
## HTML Rendering
@@ -137,7 +137,7 @@ ignore_missing_references = true
137137

138138
See [CONTRIBUTING.md](https://github.com/kyleking/mdformat-mkdocs/blob/main/CONTRIBUTING.md)
139139

140-
[ci-badge]: https://github.com/kyleking/mdformat-mkdocs/workflows/CI/badge.svg?branch=main
140+
[ci-badge]: https://github.com/kyleking/mdformat-mkdocs/actions/workflows/tests.yml/badge.svg?branch=main
141141
[ci-link]: https://github.com/kyleking/mdformat-mkdocs/actions?query=workflow%3ACI+branch%3Amain+event%3Apush
142142
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-mkdocs.svg
143143
[pypi-link]: https://pypi.org/project/mdformat-mkdocs

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ dependencies = [
1818
"mdit-py-plugins >= 0.4.1",
1919
"more-itertools >= 10.5.0",
2020
]
21+
description = "A mdformat plugin for mkdocs and mkdocs-material"
2122
keywords = ["markdown", "markdown-it", "mdformat", "mdformat_plugin_template"]
2223
license = "MIT"
2324
license-files = ["LICENSE"]
@@ -35,7 +36,7 @@ recommended = [
3536
"mdformat-beautysh >= 0.1.1",
3637
"mdformat-config >= 0.2.1",
3738
"mdformat-footnote >= 0.1.1",
38-
"mdformat-frontmatter >= 2.0.8",
39+
"mdformat-front-matters >= 0.1.0",
3940
"mdformat-gfm >=1.0.0; python_version >= '3.10'",
4041
"mdformat-ruff >= 0.1.3",
4142
"mdformat-simple-breaks >= 0.0.1",

0 commit comments

Comments
 (0)