starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 09:16:02 +03:00

[GH-ISSUE #51] Proposed rule: enforce typography #42

New issue

Open

opened 2026-03-03 01:23:15 +03:00 by kerem · 5 comments

kerem commented

2026-03-03 01:23:15 +03:00

Owner

Originally created by @flodolo on GitHub (Mar 17, 2017).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/51

Here's a few checks that I would like to have:

quotes: use proper “” instead of "".
apostrophes: use proper apostrophes ’ instead of '.
punctuation_space: enforce one space after a punctuation symbol, unless it's followed by a new line.
double_spaces: no double spaces.

I think code should be excluded by default for all these checks.

For the first two, Atom has a really nice package that might be used as inspiration.

Originally created by @flodolo on GitHub (Mar 17, 2017). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/51 Here's a few checks that I would like to have: * quotes: use proper `“”` instead of `""`. * apostrophes: use proper apostrophes `’` instead of `'`. * punctuation_space: enforce one space after a punctuation symbol, unless it's followed by a new line. * double_spaces: no double spaces. I think code should be excluded by default for all these checks. For the first two, Atom has a [really nice package](https://atom.io/packages/smart-quotes-plus) that might be used as inspiration.

kerem added the

new rule

label

2026-03-03 01:23:15 +03:00

kerem commented

2026-03-03 01:23:16 +03:00

Author

Owner

@DavidAnson commented on GitHub (Mar 17, 2017):

Double spaces was already on my list. :) Punctuation space seems fine.

But quotes worries me. The package you link to changes normal quotes to smart ones - but emphasizes that you still type dumb quotes the easy way. markdownlint is not a transformer like that. I think nobody will want to have to type smart quotes every time in order to satisfy this rule. Or am I thinking about this part wrong?

@DavidAnson commented on GitHub (Mar 17, 2017): Double spaces was already on my list. :) Punctuation space seems fine. But quotes worries me. The package you link to changes normal quotes to smart ones - but emphasizes that you still type dumb quotes the easy way. `markdownlint` is not a transformer like that. I think nobody will want to have to *type* smart quotes every time in order to satisfy this rule. Or am I thinking about this part wrong?

kerem commented

2026-03-03 01:23:16 +03:00

Author

Owner

@flodolo commented on GitHub (Mar 17, 2017):

I think nobody will want to have to type smart quotes every time in order to satisfy this rule. Or am I thinking about this part wrong?

Yes, you would either be writing the correct quotes directly, or use a package like the one above to make your life easier.

I realize that this might not be a useful rule for a lot of users, it sounds more like good material for a custom rule.

@flodolo commented on GitHub (Mar 17, 2017): > I think nobody will want to have to type smart quotes every time in order to satisfy this rule. Or am I thinking about this part wrong? Yes, you would either be writing the correct quotes directly, or use a package like the one above to make your life easier. I realize that this might not be a useful rule for a lot of users, it sounds more like good material for a custom rule.

kerem commented

2026-03-03 01:23:16 +03:00

Author

Owner

@DavidAnson commented on GitHub (Mar 17, 2017):

It fits within the bigger idea of a typography rule, but maybe this part would default to "off". I like the idea to bundle these similar checks, though.

@DavidAnson commented on GitHub (Mar 17, 2017): It fits within the bigger idea of a typography rule, but maybe this part would default to "off". I like the idea to bundle these similar checks, though.

kerem commented

2026-03-03 01:23:16 +03:00

Author

Owner

@CircleCode commented on GitHub (Apr 7, 2017):

Please also note that these rules can depend on text language.
For example, in French

you would have to enforce a non breakable space before every double punctuation sign (; : !)
valid quotes are « and »

@CircleCode commented on GitHub (Apr 7, 2017): Please also note that these rules can depend on text language. For example, in French - you would have to enforce a non breakable space before every double punctuation sign (`;` `:` `!`) - valid quotes are `«` and `»`

kerem commented

2026-03-03 01:23:16 +03:00

Author

Owner

@kdeldycke commented on GitHub (Jul 2, 2020):

Checks on properly balanced quotes and the way they terminates sentences is what I'n trying to achieve at: https://github.com/sindresorhus/awesome-lint/pull/101 . Only managed to create a set of use-cases at the moment.

@kdeldycke commented on GitHub (Jul 2, 2020): Checks on properly balanced quotes and the way they terminates sentences is what I'n trying to achieve at: https://github.com/sindresorhus/awesome-lint/pull/101 . Only managed to create a set of use-cases at the moment.

kerem referenced this issue

2026-03-07 20:02:24 +03:00

[GH-ISSUE #42] Add support for custom rules #1882