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

Add option to configure bullet conversion #2

Open
kingjon3377 opened this issue Aug 7, 2017 · 8 comments
Open

Add option to configure bullet conversion #2

kingjon3377 opened this issue Aug 7, 2017 · 8 comments

Comments

@kingjon3377
Copy link

This is the best Docs-to-Markdown conversion I've found yet, but there's still one document feature that I find I have to do significant post-processing on to get to the way I want it: bullets. I prefer to use hyphens (-), not asterisks (*), to indicate bullets in Markdown, and I want each level of indentation beyond the leftmost to be indented by two, rather than apparently four, spaces. It would be really nice if the converter either met these conventions by default or allowed the user to configure which character to use for bullets and how much to indent each subsequent level of nested bullets.

@evbacher
Copy link
Owner

evbacher commented Aug 8, 2017

Thanks for filing this, Jonathan. I'm inclined to add an option of some kind to allow a choice between hyphens and asterisks. John Gruber reported some interesting findings about this recently: https://daringfireball.net/2017/07/unordered_lists_in_markdown (Summary: - and * most popular bullets by far).

As for the indenting of nested lists: there are some Markdown renderers that have trouble with two-space indents after the second level of nesting (github Markdown is not among them). Since four-space indent seems to render correctly everywhere, I'm inclined to stick with that for now.

@kingjon3377
Copy link
Author

On reading that blog post, I realized I'd forgotten about + as a possible bullet. And maybe each level of bullets should be configurable separately?

Fair enough about the indentation. (At least this exporter seems to be consistent, now that I've figured out that it's four spaces, so I can do the conversion with one mass-replacement; whatever converter Draft uses isn't consistent, and in fact often omits the necessary line breaks between the items.)

@evbacher
Copy link
Owner

My guess is that + is too much work (have to use the shift key), while - is easiest, and * looks most like a bullet. I think that making each level configurable might be too complex and lead to a lot of UI options just for that. But I'll think about it. If/when I open-source this, you could always have a go.

Trying to be consistent with output -- please file a bug if you notice any oddities.

@fredeerock
Copy link

Allowing the option for hyphens (-) would be great! Currently using a site that doesn't recognize asterisks as bullet points for some reason.

@evbacher
Copy link
Owner

fredeerock: I'm curious about what Markdown engine you're using that does not recognize asterisks as bullets? There are too many Markdown standards to try to provide options for all of them. At some point, might try to support specific Markdown flavors, but I do not have time for that now.

@fredeerock
Copy link

It's a production management system from Autodesk called Shotgun. They say they're following GFM, but they've apparently left out a few things (https://support.shotgunsoftware.com/hc/en-us/articles/115001651373-Formatting-text-fields-with-Shotgun-Markdown).

@heyakyra
Copy link

heyakyra commented Mar 7, 2024

Since four-space indent seems to render correctly everywhere

Seems not to be true for https://github.com/dillonkearns/elm-markdown

@heyakyra
Copy link

Any chance of this enhancement getting some love?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants