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 mdformat admonition conflict (464) #465

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

Conversation

fyliu
Copy link
Member

@fyliu fyliu commented Feb 6, 2025

Fixes #464

What changes did you make?

  • Pinned mdformat-mkdocs to minimum 4.1.2
  • Removed mdformat-admon
  • Committed auto-updated md files

Why did you make the changes (we will use this info to test)?

  • Pinning causes developer machines to update to the current version.
  • Removing mdformat-admon resolves the conflict.
  • The md file updates makes the md files more readable in text form

Testing suggestion

To show that it fixes the problem for pre-commit.ci, my preview repo commit log shows pre-commit failing before and passing after the changes. (click on the small X and check mark for link to detailed output)

  1. Run pre-commit on all files (should setup mdformat-mkdocs again and pass all checks)

    pre-commit run --all-files
    
  2. Check new site for changed md files rendering (the pages should look the same (boxes, dropdowns, tabs))

@fyliu fyliu requested a review from del9ra February 6, 2025 11:22
@fyliu fyliu marked this pull request as ready for review February 6, 2025 11:26
@fyliu fyliu changed the title fix mdformat admonition conflict fix mdformat admonition conflict (464) Feb 6, 2025
Pinned mdformat-mkdocs to minimum 4.1.2
Removed mdformat-admon
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: PR Needs review (automated column, do not place items here manually)
Development

Successfully merging this pull request may close these issues.

Pre-commit mdformat hook conflict
1 participant