Comments (5)
What do you think is wrong here?
The documentation for MD026
explicitly calls out that it will trigger for ?
and !
:
https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026---trailing-punctuation-in-header
If you do not like this rule, it can be disabled completely - or you can edit the list of characters it looks for (again, see documentation above).
from markdownlint.
Fair enough. :) For what it's worth, this rule came from the Ruby implementation. I'll admit it's not my absolute favorite rule, but I think it's a good guideline in general, it's easy to turn off if you don't want it, and it's easy to customize when needed. I'm not inclined to break compatibility with the Ruby implementation over something like this, so unless you find that the rule is behaving wrongly, I will recommend turning it off. Sorry for the inconvenience!
from markdownlint.
what i think is wrong here is that the defaults are not sensible enough. :)
having a question mark at the end of a header is quite common (e.g. faqs), and requiring explicit configuration for it seems backwards to me.
from markdownlint.
yeah i understand you took the rules from another project (unsure why there are 2 implementations though), but i was not aware that you aim for keeping those rules unchanged, even when they do not make sense as defaults.
thanks for the explanation.
from markdownlint.
Hello, worth noting, that headings in writings can include question marks an exclamation marks. Yes, one of the more strange settings.
from markdownlint.
Related Issues (20)
- MD051 false positives for section titles with image in them HOT 2
- How to configure MD012 HOT 3
- Provide custom rules with other rule configurations HOT 2
- MD036 triggered right before a header HOT 1
- Set global defaults HOT 1
- [DEP0040] DeprecationWarning - punycode module is deprecated HOT 7
- New Table formatting rule HOT 4
- False positive with link-image-style rule (MD054) and `{ url_inline: false }` HOT 2
- MD003 "consistent" doesn't allow "setext_with_atx" HOT 3
- MD049, MD050 conflicts with functional differences between underscores and asterisks HOT 5
- IntelliJ plugin HOT 1
- endlessschoes08
- MD030: incorrectly firing inside HTML comments that end with `--->` after switch to micromark HOT 3
- (MD033 - Inline HTML)
- SRockt HOT 1
- Ignore long lines in HTML comments HOT 3
- MD044: Proper name matched in Hugo-style relref links HOT 7
- MD025 Multiple top-level headings with`title` frontmatter HOT 1
- MD025: Support docfx tabs
- MD051: Support docfx tabs HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from markdownlint.