prosemirror/prosemirror-markdown
1
0
Fork 0
Code Issues 3 Pull requests Activity

Unnecessary escape for # character #105

New issue
Closed
opened 2023-07-27 13:45:56 +02:00 by dragonman225 · 2 comments
dragonman225 commented 2023-07-27 13:45:56 +02:00 (Migrated from github.com)
Copy link

Problem

According to the CommonMark spec, # that is not followed by spaces, tabs, or the end of line, would not become headings.

Example:
https://spec.commonmark.org/dingus/?text=%23%20abc%20(heading)%0A%0A%23abc%20(not%20heading)%0A%0A%23%0A(%E2%86%91%20empty%20heading)%0A

But the serializer of prosemirror-markdown escapes # even if the text would not be parsed as headings. e.g.

#foo

would be serialized back to

\#foo

making the generated Markdown less clean and less readable.

Solution

Given my previous experience with #101, I wonder if this can be solved by changing the regular expressions in the esc function a bit.

### Problem According to the [CommonMark spec](https://spec.commonmark.org/0.30/#atx-headings), `#` that is not followed by spaces, tabs, or the end of line, would not become headings. Example: https://spec.commonmark.org/dingus/?text=%23%20abc%20(heading)%0A%0A%23abc%20(not%20heading)%0A%0A%23%0A(%E2%86%91%20empty%20heading)%0A But the serializer of `prosemirror-markdown` escapes `#` even if the text would not be parsed as headings. e.g. ``` #foo ``` would be serialized back to ``` \#foo ``` making the generated Markdown less clean and less readable. ### Solution Given my previous experience with #101, I wonder if this can be solved by changing the regular expressions in the `esc` function a bit.
marijnh commented 2023-07-27 21:36:15 +02:00 (Migrated from github.com)
Copy link

Yes, this sounds like it could also be fixed by not matching these characters if they are followed by non-whitespace. Want to submit a PR?

Yes, this sounds like it could also be fixed by not matching these characters if they are followed by non-whitespace. Want to submit a PR?
dragonman225 commented 2023-07-28 08:30:38 +02:00 (Migrated from github.com)
Copy link

Sure! I'll try.

Sure! I'll try.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
1.13.4
1.13.3
1.13.2
1.13.1
1.13.0
1.12.0
1.11.2
1.11.1
1.11.0
1.10.1
1.10.0
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.0
1.7.1
1.7.0
1.6.2
1.6.1
1.6.0
1.5.2
1.5.1
1.5.0
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.2
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.1
1.1.0
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.11.0
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
prosemirror/prosemirror-markdown#105
No description provided.