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

Convert list item markers #83

Closed
hukkin opened this issue Oct 27, 2020 · 4 comments · Fixed by #84
Closed

Convert list item markers #83

hukkin opened this issue Oct 27, 2020 · 4 comments · Fixed by #84
Labels
enhancement New feature or request

Comments

@hukkin
Copy link
Member

hukkin commented Oct 27, 2020

Convert list item marker symbols. For unordered lists, always prefer -. If there are sequential lists, alternate between - and *.

Do the same for ordered lists using . (preferred) and ).

@antazoey
Copy link

antazoey commented Dec 15, 2022

What is the reasoning for preferring - over * ?
Would it make sense to allow this to be configurable?

@hukkin
Copy link
Member Author

hukkin commented Dec 15, 2022

There is no reason besides that mdformat is opinionated and happens to prefer -, and that - happens to be easier to access on some keyboard layouts. See https://mdformat.readthedocs.io/en/stable/contributors/contributing.html#contributing on adding configuration options.

@antazoey
Copy link

Based on this sentence from the contributing guide:

Note that mdformat is an opinionated tool that attempts to keep formatting style changing configuration to its minimum. ? > New configuration will only be added for a very good reason and use case.

I sense that a PR that adds a configuration option for preferring * may not be wanted.

I do personally prefer the * a little more because I can't see the hyphen symbol very well, but it is NBD.

@hukkin
Copy link
Member Author

hukkin commented Dec 16, 2022

Yes, I don't think this is a strong enough reason to justify the conf option.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants