forked from galaxyproject/galaxy-hub
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.markdownlint.yaml
85 lines (69 loc) · 3.05 KB
/
.markdownlint.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
---
# Some of this is based off of gridsome's website markdownlint configuration.
# It'll be an incremental process figuring out what we want to fix or relax.
# markdownlint schema example: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
#########################################################
# This first set of errors cannot be automatically fixed.
#########################################################
MD001: false # heading-increment/header-increment
MD002: false # first-heading-h1/first-header-h1
MD003: false # heading-style/header-style
# Markdown files don't need to observe a line length limit.
MD013: false # line-length
# It's acceptable to have duplicate headers in the same file sometimes, like
# when multiple sections have a subsection called "### Example".
MD024: false # no-duplicate-heading/no-duplicate-header
MD025: false # single-title/single-h1
MD028: false # no-blanks-blockquote - Blank line inside blockquote
MD029: false # ol-prefix
MD033: false # no-inline-html
# # We use inline HTML to embed the Newsletter component in a page.
# allowed_elements:
# - div
# - Newsletter
MD035: false # hr-style - Horizontal rule style
MD036: false # no-emphasis-as-heading/no-emphasis-as-header
MD040: false # fenced-code-language - Fenced code blocks should have a language specified
MD041: false # first-line-heading/first-line-h1
MD042: true # no-empty-links
MD043: false # required-headings/required-headers - Required heading structure
MD045: false # no-alt-text - Images should have alternate text (alt text)
MD046: false # code-block-style
MD048: false # code-fence-style
#####################################################################
# The following error classes *can* be automatically fixed with --fix
#####################################################################
MD004: true # ul-style
MD005: true # list-indent
MD007: # ul-indent
indent: 4
MD009: true # no-trailing-spaces
MD010: # MD010/no-hard-tabs
code_blocks: false # ignore tabs in code blocks, which are generally intentional
MD011: false # no-reversed-links
MD012: false # no-multiple-blanks
MD014: false # commands-show-output
MD018: false # no-missing-space-atx
MD019: false # no-multiple-space-atx
MD020: false # no-missing-space-closed-atx
MD021: false # no-multiple-space-closed-atx
MD022: false # blanks-around-headings
MD023: false # heading-start-left
# Without this rule suppression, the linter flags trailing punctuation in
# headers like "## What makes Gridsome sites fast?" but we allow headers
# like that.
MD026: false # no-trailing-punctuation
MD027: true # no-multiple-space-blockquote
MD030: true # list-marker-space
MD031: true # blanks-around-fences
MD032: true # blanks-around-lists
# The linter flags http://example.com and wants them formatted like
# <http://example.com>, but this doesn't improve readability.
MD034: false # no-bare-urls
MD037: false # no-space-in-emphasis
MD038: false # no-space-in-code
MD039: false # no-space-in-links
MD044: true # proper-names
# names:
# - "ChIP-seq"
MD047: true # single-trailing-newline