Comments (4)
I ran this by Mark and we're thinking to use something close to the following list for both JavaScript and Ruby. Both implementations will support both naming styles interchangeably. I've got an idea how I want to code this and should be able to make progress this week.
MD001 - header-indent - Header levels should only increment by one level at a time
MD002 - first-header-h1 - First header should be a h1 header
MD003 - header-style - Header style
MD004 - ul-style - Unordered list style
MD005 - list-indent - Inconsistent indentation for list items at the same level
MD006 - ul-start-left - Consider starting bulleted lists at the beginning of the line
MD007 - ul-indent - Unordered list indentation
MD009 - no-trailing-spaces - Trailing spaces
MD010 - no-hard-tabs - Hard tabs
MD011 - no-reversed-links - Reversed link syntax
MD012 - no-multiple-blanks - Multiple consecutive blank lines
MD013 - line-length - Line length
MD014 - commands-show-output - Dollar signs used before commands without showing output
MD018 - no-missing-space-atx - No space after hash on atx style header
MD019 - no-multiple-space-atx - Multiple spaces after hash on atx style header
MD020 - no-missing-space-closed-atx - No space inside hashes on closed atx style header
MD021 - no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style header
MD022 - blanks-around-headers - Headers should be surrounded by blank lines
MD023 - header-start-left - Headers must start at the beginning of the line
MD024 - no-duplicate-header - Multiple headers with the same content
MD025 - single-h1 - Multiple top level headers in the same document
MD026 - no-trailing-punctuation - Trailing punctuation in header
MD027 - no-multiple-space-blockquote - Multiple spaces after blockquote symbol
MD028 - no-blanks-blockquote - Blank line inside blockquote
MD029 - ol-prefix - Ordered list item prefix
MD030 - list-marker-space - Spaces after list markers
MD031 - blanks-around-fences - Fenced code blocks should be surrounded by blank lines
MD032 - blanks-around-lists - Lists should be surrounded by blank lines
MD033 - no-inline-html - Inline HTML
MD034 - no-bare-urls - Bare URL used
MD035 - hr-style - Horizontal rule style
MD036 - no-emphasis-as-header - Emphasis used instead of a header
MD037 - no-space-in-emphasis - Spaces inside emphasis markers
MD038 - no-space-in-code - Spaces inside code span elements
MD039 - no-space-in-links - Spaces inside link text
MD040 - fenced-code-language - Fenced code blocks should have a language specified
MD041 - first-line-h1 - First line in file should be a top level header
from markdownlint.
So I've finally gotten around to working on implementing this (in ruby markdownlint), and took another look at the rule names. What are your thoughts on MD001 / header-indent being labeled something like header-increment or something like header-levels? The headers aren't really indented.
from markdownlint.
Thanks for the suggestion! I'm a big fan of ESLint and like the readability rule names offer. In this case, markdownlint
has its roots in a Ruby implementation and I wanted to maintain as much compatibility as possible, so I used the same MD### system for naming. (More info: http://dlaa.me/blog/post/markdownlint)
That said, I think I could support both systems (MD### for compatibility and short-rule-names for readability). I'll look into supporting this soon - or else follow up here with a reason I don't think it will work.
from markdownlint.
Agreed, I like your proposal of header-increment
better!
from markdownlint.
Related Issues (20)
- MD055/56 Don't properly handle pipes in content HOT 4
- MD013: can I set blockquote line length? HOT 5
- MD029: Ordered list with Note block HOT 1
- The rule "MD050 - Strong style" should show problems in a file, but does not. HOT 3
- MD029: any interest in zero_one_or_ordered? HOT 9
- MD013 : Issue with MarkdownLint Configuration Ignoring Line Length Exceeding 80 Words HOT 3
- Customizing plugins, other options with VSCode extension HOT 2
- MD034: Email autolink with incomplete domain in angle brackets incorrectly reported as a violation HOT 2
- MD050 Regression HOT 4
- MD033 : allowed_elements ignoring the <kdb> element HOT 3
- Can someone help if I'm lost. Thanks HOT 1
- Use markdownlint wirth quarto ".qmd" - files HOT 4
- Pi HOT 1
- fv HOT 1
- markdownlint HOT 1
- MD051 false positive `## $\LaTeX$ hooks` ⟼ `[latex hooks](#latex-hooks)` HOT 1
- MD013 false positive when url contains # HOT 8
- Formatter functionality: adjust table size to its content HOT 8
- MD051 support icon HOT 11
- Enhance rule MD033 to be more specific/targetted HOT 7
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.