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

Update defaults to match CommonMark & Github conventions #425

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

zm-cttae
Copy link

@zm-cttae zm-cttae commented Mar 4, 2023

Closes #424.
This pull introduces the CommonMark (now Github flavor, Reddit flavor) conventions that people use.

CommonMark is so popular compared to Josh Gruber's original Markdown spec that we should favor it.

@zm-cttae
Copy link
Author

zm-cttae commented Mar 4, 2023

@pavelhoral please review!

@domchristie
Copy link
Collaborator

Are these defaults specified anywhere?
(FWIW the current defaults originate from the John Gruber’s original markdown spec)

@zm-cttae
Copy link
Author

zm-cttae commented Mar 5, 2023

John Gruber's spec - the first set of conventions - aren't really used as much nowadays 🤔

These GitHub conventions are all listed here, but never explained as "conventions":

@zm-cttae
Copy link
Author

zm-cttae commented Mar 5, 2023

Good news 🎉 - CommonMark's Markdown reference help page clearly matches and favours these conventions
Per https://commonmark.org/help/

@zm-cttae zm-cttae changed the title Update defaults to match Github conventions Update defaults to match CommonMark & Github conventions Mar 5, 2023
@acnebs
Copy link

acnebs commented Jul 6, 2023

There is a type in the commit, codeBlockStyle should be fenced not fence.

@zm-cttae
Copy link
Author

zm-cttae commented Jul 6, 2023

Cheers thanks for that @acnebs

@huan086
Copy link

huan086 commented Jul 20, 2023

br shouldn't be change from hard break '␠␠' to soft break '\n'. When converting to HTML, Common mark states that conversion of hard break is to br, but soft break stays as '\n'. In HTML, '\n' is shown as a space unless the element is style with the various pre styles

@zm-cttae
Copy link
Author

Done @huan086

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.

[opinionated] Prefer emitting hyphen - over asterisk * for unordered list markup
4 participants