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.

Sign up for GitHub

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

Jump to bottom

Change unordered marker from asterisk to dash #3

Closed
arcticicestudio opened this issue Nov 15, 2018 · 2 comments
Closed

Change unordered marker from asterisk to dash #3

arcticicestudio opened this issue Nov 15, 2018 · 2 comments
Labels
context-api scope-compatibility scope-ux type-improvement
Milestone
0.2.0

Comments

@arcticicestudio
Copy link
Contributor

The currently used asterisk * should be changed to dashes -. The main reason is that asterisks * can be confused for bold/italic markers. There was also a very long discussion for Prettier to also change the default to dashes to same reasons which was then adapted.
There are some other reasons like the alignment with the YAML spec which uses dashes for list items.

This guide will now also adapt to this improvement by changing the default unordered list marker from asterisks * to dashes -.
arcticicestudio added a commit that referenced this issue Nov 15, 2018
@arcticicestudio
Change unordered marker from asterik to dash
df5d523 
The previously used asterisk `*` have been changed to dashes `-`. The
main reason is that asterisks `*` can be confused for bold/italic
markers. There was also a very long discussion (1) for Prettier (2) to
also change the default to dashes to same reasons which was then
adapted (3).
There are some other reasons like the alignment with the YAML spec which
uses dashes for list items.

This guide has now also adapted to this improvement by changing the
default unordered list marker (4) from asterisks `*` to dashes `-`.

References:

  (1) prettier/prettier#4251 (comment)
  (2) https://prettier.io
  (3) prettier/prettier#4440
  (4) https://arcticicestudio.github.io/styleguide-markdown/rules/lists.html

GH-3
arcticicestudio added a commit that referenced this issue Nov 15, 2018
@arcticicestudio
Fix linting errors due to rule change
d8c7689 
GH-3
@arcticicestudio arcticicestudio added this to the 0.2.0 milestone Nov 15, 2018
@arcticicestudio arcticicestudio mentioned this issue Nov 15, 2018
Merged
@arcticicestudio arcticicestudio changed the title Change unordered marker from asterik to dash Change unordered marker from asterisk to dash Nov 15, 2018
arcticicestudio added a commit that referenced this issue Nov 15, 2018
@arcticicestudio
Update to [email protected]
35aeddb 
This version includes the changes of this improvement to ensure the
linting stage is passing correctly.

GH-3
arcticicestudio added a commit that referenced this issue Nov 15, 2018
@arcticicestudio
Merge pull request #4 from arcticicestudio/improvement/gh-3-unordered…
fea20a6 
…-marker-asterik-to-dash

Change unordered marker from asterisk to dash
@hutou hutou mentioned this issue Oct 8, 2019
Merged
@manishprivet
Copy link

This is causing a problem in .md files in my case, where I've to insert a Thematic break using *** but Prettier is constantly changing it to ---

Any possible solutions for it?

@arcticicestudio
Copy link
Contributor Author

@manishprivet This change was only related to lists, but using *** for horizontal rules can be seen as problematic as the previously used * characters for lists. --- on the other hand should be fine in any case because there are more than one dash without a whitespace. Anyway, if you still like to keep *** you can simply add a Prettier ignore comment above it to stop Prettier from formatting/changing it:

<!-- prettier-ignore -->
***

@Ceredron Ceredron mentioned this issue Dec 8, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
context-api scope-compatibility scope-ux type-improvement
Projects
None yet
Milestone
0.2.0
Development

No branches or pull requests
2 participants
@arcticicestudio @manishprivet