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

fix upstream markdown ambiguities, inconsistencies, and ordered listing antipatterns #20

Open
naturallymitchell opened this issue Mar 7, 2019 · 0 comments

Comments

@naturallymitchell
Copy link
Member

naturallymitchell commented Mar 7, 2019

needs: 1) feature complete structured writing, automatic list item numbering 2) unambiguous syntax 3) round-tripping between markup and markdown

numbering # for list ordering
portioning % for text sectioning, paragraphs
bulletting * for unordered listing

~~
raw notes:
~~

bug: ordered list syntax uses ambiguous, cumbersome, hardcoded symbols

https://spec.commonmark.org/0.28/#ordered-list-marker
https://en.wikipedia.org/wiki/Hard_coding (antipattern)

using unique, hardcoded characters for each list item, and then an ambiguous ending character is breaking my content. I'd like to change this syntax to a single character syntax.

the number sign, #, would make the most sense to me, since we're numbering things. this would make for an easy fix with nesting ordered lists, because then we could use multiple markers for list depth.

related: # [ ]

~~

bug: heading syntax uses a number symbol, instead of a portion symbol

https://spec.commonmark.org/0.28/#atx-heading
https://en.wikipedia.org/wiki/Number_sign

this bug also breaks numbering things. see []#

percentage is a portion calculated in terms of the rest of the portions, but it's the closest general character I can find to indicate a portion

the only other one I can think of is + a plus sign, but that's part of the problem I'm trying to solve. I would like to better organize content across documents for a combinatorial value whose mechanisms work differently than simple addition.

~~

~~

~~

@naturallymitchell naturallymitchell changed the title fix upstream markdown ambiguities fix upstream markdown ambiguities, inconsistencies, and ordered listing antipatterns Mar 7, 2019
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