Skip to content

Conversation

@kdeldycke
Copy link
Contributor

@kdeldycke kdeldycke commented Nov 24, 2025

mdformat-frontmatter is not compatible with mdformat 1.0.0, and seems unmaintained.

This PR replace it with mdformat-front-matters, which is actively maintained by @KyleKing and is becoming the de-facto frontmatter plugin in the mdformat universe, because of its adoption by mdformat-mkdocs.

This PR addresses #45.

Also to align the requirements with its dependencies, this PR bump the minimal Python version from 3.9 to 3.10. As a bonus, I activated tests on Python 3.14 and 3.15-dev.

Relates to:

@kdeldycke kdeldycke force-pushed the fix-mdformat-frontmatter-dependency branch from 6dfa0e0 to f26b25b Compare November 24, 2025 04:33
@kdeldycke kdeldycke force-pushed the fix-mdformat-frontmatter-dependency branch 2 times, most recently from 95afeee to 6667793 Compare November 24, 2025 04:38
@kdeldycke kdeldycke force-pushed the fix-mdformat-frontmatter-dependency branch 2 times, most recently from c7d33a7 to a9e2b47 Compare November 24, 2025 04:45
kdeldycke added a commit to kdeldycke/mdformat-myst that referenced this pull request Nov 24, 2025
@kdeldycke kdeldycke force-pushed the fix-mdformat-frontmatter-dependency branch 2 times, most recently from 164faf3 to bb70265 Compare November 24, 2025 04:47
kdeldycke added a commit to kdeldycke/mdformat-myst that referenced this pull request Nov 24, 2025
Run tests on Python 3.14 and 3.15-dev
kdeldycke added a commit to kdeldycke/mdformat-myst that referenced this pull request Nov 24, 2025
Run tests on Python 3.14 and 3.15-dev
@kdeldycke kdeldycke force-pushed the fix-mdformat-frontmatter-dependency branch from bb70265 to 487b64a Compare November 24, 2025 04:47
@kdeldycke kdeldycke changed the title ⬆️ UPGRADE: Replace mdformat-frontmatter with mdformat-front-matters ⬆️ Replace mdformat-frontmatter with mdformat-front-matters Nov 24, 2025
@kdeldycke
Copy link
Contributor Author

All tests are passing, this PR is ready to me merged upstream.

Copy link
Collaborator

@KyleKing KyleKing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! I can approve, merge, and release once these comments are addressed

---
lastname: Blorothy
firstname: Dorothy
lastname: Blorothy
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the change in default to sort front matter be an issue for MyST adoption? If so, I can flip the default for better backward compatibility

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! We both need input from mdformat-myst maintainers here.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There hasn't been any input, so I think we can proceed. I'll communicate this change in the changelog and how to turn it off, then making a breaking release for both that dependency swap and dropping 3.9!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can you hold off on merging?

I’m going to release a 1.0.0 tonight that doesn’t sort by default. For most, frontmatter is manually written, so better to keep however it was ordered: eyeseast/python-frontmatter#26 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah sure! Take your time! :)

@kdeldycke kdeldycke force-pushed the fix-mdformat-frontmatter-dependency branch from 487b64a to c71ac9b Compare November 24, 2025 17:07
Copy link
Collaborator

@KyleKing KyleKing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! LGTM!

---
lastname: Blorothy
firstname: Dorothy
lastname: Blorothy
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There hasn't been any input, so I think we can proceed. I'll communicate this change in the changelog and how to turn it off, then making a breaking release for both that dependency swap and dropping 3.9!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

mdformat_myst not compatible with mdformat 1.0.0 because of mdformat_frontmatter

2 participants