Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix!: add expected newline #44

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix!: add expected newline #44

wants to merge 1 commit into from

Conversation

KyleKing
Copy link
Owner

@KyleKing KyleKing commented Nov 21, 2024

Addresses KyleKing/mdformat-admon#22 and that content tabs also include an extra newline https://squidfunk.github.io/mkdocs-material/reference/content-tabs/

There are some issues to address before merging. This will be a breaking change and needs to be versioned accordingly

# A mapping from syntax tree node type to a function that renders it.
# This can be used to overwrite renderer functions of existing syntax
# or add support for new syntax.
RENDERERS: Mapping[str, Render] = {
"admonition_mkdocs": ADMON_RENDERS["admonition"],
# TODO: address conflict with mdformat-admon because mkdocs needs to override
Copy link
Owner Author

@KyleKing KyleKing Nov 22, 2024

Choose a reason for hiding this comment

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

Currently separating the shared utilities from mdformat-admon into a non-plugin utility package to avoid this conflict (https://github.com/KyleKing/mdformat-admonition-utils)

I also want to revisit the API and see if I can make a more composable version that doesn’t make so many assumptions

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.

1 participant