Skip to content

Markdown Unordered List Item Symbol  #4251

@ashfurrow

Description

@ashfurrow

Hello Prettier! I'm a big fan of using Prettier in my JavaScript projects, and I recommend it to all my friends an colleagues. I was really excited about the addition of Markdown formatting, until I found that unordered list items are delineated with * instead of - (see this issue for initial discussion).

I have never even seen * used for list items before Prettier started changing my markdown files. I think I knew it was part of the Markdown spec but I'd never seen it used in practice. I stopped using Prettier for Markdown as a result, and I'm not the only one. I do appreciate that Prettier is opinionated, but in this case the "opinion" was informed only by a measure of "what's more common" based on a Big Data query that I can't seem to access (so I can't assess the quality of the data). I would argue that, absent an advocate from either side, this opinion lacks context. And even taking the data on face value, - use stood at 39%, which I believe is enough to warrant a discussion around an option to support it.

Personally, - makes far more sense to me as a list item symbol because it matches the YAML notation for list items. It is also widely used in word processors to begin lists (type - on a new line and both Word and Pages will automatically convert it into a list for you). Not so with *.

A popular Markdown style guide recommends - for list items because * can be confused for bold/italic markers. Other style guides also recommend - (although I did find one guide that used * but did not explicitly recommending it).

Based on discussion on the initial issue, there is strong interest in an option for -, and even interest in outright changing to - entirely. What do others think? Thanks for your consideration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    lang:markdownIssues affecting Markdownlocked-due-to-inactivityPlease open a new issue and fill out the template instead of commenting.status:has prIssues with an accompanying pull request. These issues will probably be fixed soon!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions