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

leads to "breakage" according to mdformat internal check: #1

Open
yarikoptic opened this issue Nov 18, 2023 · 0 comments
Open

leads to "breakage" according to mdformat internal check: #1

yarikoptic opened this issue Nov 18, 2023 · 0 comments

Comments

@yarikoptic
Copy link

got to this repo from hukkin/mdformat#4 -- I just discovered mdformat and wanted to introduce to our projects while enforcing one sentence per line. But while trying on https://github.com/dandi/handbook -- got it to fail:

❯ mdformat docs/01_introduction.md
changes on filesystem:                                                                                                           
 docs/01_introduction.md | 12 ++++++------

❯ git reset --hard
HEAD is now at 3182e49 Wording fixups

❯ pip install mdformat-sentencebreak
Collecting mdformat-sentencebreak
  Using cached mdformat_sentencebreak-0.4.0-py3-none-any.whl (5.2 kB)
Requirement already satisfied: mdformat<0.8.0,>=0.7.16 in /home/yoh/venvs/dev3.11/lib/python3.11/site-packages (from mdformat-sentencebreak) (0.7.17)
Requirement already satisfied: markdown-it-py<4.0.0,>=1.0.0 in /home/yoh/venvs/dev3.11/lib/python3.11/site-packages (from mdformat<0.8.0,>=0.7.16->mdformat-sentencebreak) (2.2.0)
Requirement already satisfied: mdurl~=0.1 in /home/yoh/venvs/dev3.11/lib/python3.11/site-packages (from markdown-it-py<4.0.0,>=1.0.0->mdformat<0.8.0,>=0.7.16->mdformat-sentencebreak) (0.1.2)
Installing collected packages: mdformat-sentencebreak
Successfully installed mdformat-sentencebreak-0.4.0

❯ mdformat docs/01_introduction.md
Error: Could not format "/home/yoh/proj/dandi/handbook/docs/01_introduction.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
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

No branches or pull requests

1 participant