-
Notifications
You must be signed in to change notification settings - Fork 2
/
.remarkrc.yaml
161 lines (138 loc) · 6.37 KB
/
.remarkrc.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
##########
# remark #
##########
# [OVERVIEW] remark — Markdown linter:
# https://remark.js.org/
#
# [INFO] Example file:
# https://github.com/zemanlx/container-structure-test-image/blob/master/.remarkrc.yaml
#
# [INFO] CLI usage:
# https://github.com/remarkjs/remark/tree/master/packages/remark-cli#cli
#
# [INFO] Inline ignoring rules:
# https://github.com/remarkjs/remark-lint#configuring-remark-lint
#
# [WARNING] Ignoring specific rules as “lint disable no-duplicate-headings” doesn't work;
# use “lint disnable” and “lint enable”
# No issue, because remark author close my previous issues, but not solve them:
# https://github.com/remarkjs/remark-validate-links/issues/33
# https://github.com/remarkjs/remark-validate-links/issues/32
###########
# Presets #
###########
# [INFO] Preset usage:
# https://github.com/remarkjs/remark-lint#list-of-presets
# [NOTE] I don't use “consistent” preset; these aren’t strict rules
# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-consistent
plugins:
preset-lint-recommended:
preset-lint-markdown-style-guide:
###########
# Plugins #
###########
# https://github.com/remarkjs/remark/blob/master/doc/plugins.md#list-of-plugins
##################
# validate-links #
##################
# Validate relative links plugin:
# https://www.npmjs.com/package/remark-validate-links
# [WARNING] I disable this plugin, because many unexpected warnings:
# https://github.com/remarkjs/remark-validate-links/issues/32
# https://github.com/remarkjs/remark-validate-links/issues/33
# validate-links:
###################
# lint-write-good #
###################
# Prose linter
# https://www.npmjs.com/package/write-good
# Remark wrapper
# https://www.npmjs.com/package/remark-lint-write-good
lint-write-good:
# [INFO] Explanations:
# https://github.com/btford/write-good/blob/master/write-good.js#L12-L22
# [NOTE] Example, how disable specific explanations:
# illusion: false
#########
# Rules #
#########
# Remark rules:
# https://github.com/remarkjs/remark-lint#rules
# External rules:
# https://github.com/remarkjs/remark-lint#list-of-external-rules
# [NOTE] WTF. Markdown is markup for articles, not for code. User can write as much as he wants.
lint-maximum-line-length: false
# [INFO] Use “+” as unordered lists marker style:
# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style
# Possible change all:
# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style#fix
lint-unordered-list-marker-style: +
# [NOTE] I use mdx_downheader, that downgrade headers
# https://github.com/cprieto/mdx_downheader
lint-no-multiple-toplevel-headings: false
# [FIXME] Needs plugin, that redirect lowercase to mixed case:
# [NOTE] You need use lowercase in URLs:
# https://webmasters.stackexchange.com/a/56180/71131
# https://www.quora.com/Should-URLs-ever-have-capital-letters
# [INFO] Oppose opinion — mixed letters in URLs:
# https://stackoverflow.com/a/33489532/5951529
# https://webmasters.stackexchange.com/a/56177/71131
# [INFO] The domain part is not case sensitive. GoOgLe.CoM works.
# https://stackoverflow.com/a/13511455/5951529
lint-no-file-name-mixed-case: false
# [NOTE] Google: Using non-English URLs for non-English websites is fine
# https://searchengineland.com/google-using-non-english-urls-non-english-websites-fine-294758
# [INFO] Reserved characters:
# https://webmasters.stackexchange.com/a/508/71131
lint-no-file-name-irregular-characters: false
# [NOTE] I can use literal URLs in Pelican metadata:
# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-literal-urls
lint-no-literal-urls: false
# [NOTE] I prefer tabs, not spaces:
# https://softwareengineering.stackexchange.com/a/2037/264224
# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-list-item-indent
lint-list-item-content-indent: false
# [NOTE] Sublime MarkdownTOC add unique ids for headers:
# https://packagecontrol.io/packages/MarkdownTOC
# https://github.com/naokazuterada/MarkdownTOC#auto-anchoring-when-heading-has-anchor-defined
# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-no-duplicate-headings
lint-no-duplicate-headings: false
# [WARNING] I don't think, that blank lines needest, if elements of nested list have
# no more, than one line:
# https://github.com/cirosantilli/markdown-style-guide/issues/4
# https://github.com/remarkjs/remark-lint/issues/78
lint-list-item-spacing: false
# [FIXME] Maximum line-heigth not needed, if I use Sublime MarkdownTOC,
# but needed for Pelican generation.
# https://github.com/cirosantilli/markdown-style-guide/issues/5
# http://www.cirosantilli.com/markdown-style-guide/#header-length
# [NOTE] But title size there should be no more than 70 symbols:
# https://webmasters.stackexchange.com/a/92011/71131
# https://www.hildamateiu.com/docs/search-engine-optimization-starter-guide.pdf
# https://www.tutorialrepublic.com/faq/what-is-the-maximum-length-of-title-and-meta-description-tag.php
lint-maximum-heading-length: false
# [NOTE] Symbol after list marker. For “space” value:
# Valid:
# 1. Kira list item
# Non-valid:
# 1. Kira list item
# https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-list-item-indent
lint-list-item-indent: 'space'
# [WARNING] Both disabled, because jtable syntax not support:
# https://github.com/remarkjs/remark-lint/issues/202
# [FIXME] Add remark-macro and remark-stringify to config:
# https://github.com/remarkjs/remark-lint/issues/202#issuecomment-462050887
lint-no-shortcut-reference-link: false
lint-no-undefined-references: false
# [INFO] Disable, because EscapeAll syntax not support:
# https://github.com/remarkjs/remark-lint/issues/202
# [INFO] Enable, because exceptions are rare; inline ignoring possible:
lint-no-inline-padding: true
# [WARNING] Disable, because Admonition syntax not support:
# https://github.com/remarkjs/remark-lint/issues/202
lint-code-block-style: false
# [NOTE] I don’t use *italic* text “as heading”,
# I use it to highlight text.
# Therefore, this rule is deactivated.
# https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-emphasis-as-heading
lint-no-emphasis-as-heading: false