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

feat(nuemark)!: proposal to use different section separator #477

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

Conversation

nobkd
Copy link
Collaborator

@nobkd nobkd commented Feb 5, 2025

Increase cmark compatibility by a tiny bit.

Use +++ as section separator, makes it clear, that no traditional <hr> is used

hello section 1

+++

hello section 2

@nobkd nobkd changed the title feat(nuemark!: proposal to use pluses as section separator feat(nuemark)!: proposal to use pluses as section separator Feb 5, 2025
@nobkd nobkd requested a review from tipiirai February 11, 2025 02:27
@tipiirai
Copy link
Contributor

Damn. A tough decision. I understand where you're coming from. I think feature changes of this caliber should be discussed first. I feel +++ puts this closer to hackers and not content writers, which is the goal. I also don't value commonmark very highly. Content development experience is the priority. Do you think +++ is better than === ?

@nobkd
Copy link
Collaborator Author

nobkd commented Feb 13, 2025

I thought about new (section) on the plus symbol, but it doesn't really matter. We can also use === as section splitter.
But I wouldn't use ---, because I always used it as <hr> (and didn't know about e.g. *** as valid alternative) and it feels most intuitive for <hr> (for me) too.

I can see both +++ and === as viable/valid options. The decision is, what you like more, though. (or allow both 🤷‍♂️ :)
I'll change the code depending on your preference.

Alternatively I can also close this one and we can discuss this first somewhere else.

@nobkd nobkd changed the title feat(nuemark)!: proposal to use pluses as section separator feat(nuemark)!: proposal to use different section separator Feb 13, 2025
@tipiirai
Copy link
Contributor

tipiirai commented Feb 14, 2025

My original idea with --- was to use the same separator as in front matter. One syntax to remember. But I feel this is often used as <hr>. This is a compromise, but I'm leaning towards "---" as section separator. It feels so natural, especially inside blocks.

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.

2 participants