search

executablebooks / mdformat

CommonMark compliant Markdown formatter
https://mdformat.rtfd.io
MIT License
413 stars 45 forks source link

Error: Could not format #413

Closed seancolsen closed 11 months ago

seancolsen commented 1 year ago

Describe the bug

mdformat is unable to format a Markdown document I have.

Reproduce the bug

  1. Use this README.md file.
  2. Run mdformat README.md
  3. Expect the document to be formatted

  4. Instead, observe the following error:

    Error: Could not format "/home/sean/cci/repo/mathesar/docs/README.md".

    The formatted Markdown renders to different HTML than the input Markdown. This is likely a bug in mdformat. Please create an issue report here, including the input Markdown: https://github.com/executablebooks/mdformat/issues

List your environment

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

hukkin commented 11 months ago

Thanks for the issue!

Vanilla mdformat has no trouble formatting your text. The issue seems to only occur with the externally developed plugin you use, mdformat_mkdocs. You should file an issue here https://github.com/KyleKing/mdformat-mkdocs/issues