GeezerVison is showing github.com — powertools-lambda-python/.markdownlint.yaml at develop · DKurilo/powertools-lambda-python

Expand file tree

.markdownlint.yaml

Copy path

More file actions

Latest commit

History

240 lines (191 loc) · 6.38 KB

.markdownlint.yaml

Copy path

File metadata and controls

240 lines (191 loc) · 6.38 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

# Rules: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

# Default state for all rules

default: true

# Path to configuration file to extend

extends: null

# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time

MD001: true

# MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading

# NOTE: We use h2 due to font size

MD002: false

# MD003/heading-style/header-style - Heading style

MD003:

# Heading style

style: "consistent"

# MD004/ul-style - Unordered list style

MD004:

# List style

style: "consistent"

# MD005/list-indent - Inconsistent indentation for list items at the same level

MD005: true

# MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line

MD006: true

# MD007/ul-indent - Unordered list indentation

MD007:

# Spaces for indent

indent: 4

# Whether to indent the first level of the list

start_indented: false

# Spaces for first level indent (when start_indented is set)

start_indent: 2

# MD009/no-trailing-spaces - Trailing spaces

MD009:

# Spaces for line break

br_spaces: 2

# Allow spaces for empty lines in list items

list_item_empty_lines: false

# Include unnecessary breaks

strict: false

# MD010/no-hard-tabs - Hard tabs

# NOTE: Mkdocs Material theme features like code annotations, tabbed content require it

MD010: false

# MD011/no-reversed-links - Reversed link syntax

MD011: true

# MD012/no-multiple-blanks - Multiple consecutive blank lines

MD012:

# Consecutive blank lines

maximum: 1

# MD013/line-length - Line length

MD013:

# Number of characters

line_length: 380

# Number of characters for headings

heading_line_length: 80

# Number of characters for code blocks

code_block_line_length: 265

# Include code blocks

code_blocks: true

# Include tables

tables: false

# Include headings

headings: true

# Strict length checking

strict: false

# Stern length checking

stern: false

# MD014/commands-show-output - Dollar signs used before commands without showing output

MD014: true

# MD018/no-missing-space-atx - No space after hash on atx style heading

MD018: true

# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading

MD019: true

# MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading

MD020: true

# MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading

MD021: true

# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines

MD022:

# Blank lines above heading

lines_above: 1

# Blank lines below heading

lines_below: 1

# MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line

MD023: true

# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content

MD024:

# Only check sibling headings

siblings_only: false

# MD025/single-title/single-h1 - Multiple top-level headings in the same document

MD025:

# Heading level

level: 1

# RegExp for matching title in front matter

front_matter_title: "^\\s*title\\s*[:=]"

# MD026/no-trailing-punctuation - Trailing punctuation in heading

MD026:

# Punctuation characters

punctuation: ".,;:!。，；：！"

# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol

MD027: true

# MD028/no-blanks-blockquote - Blank line inside blockquote

MD028: true

# MD029/ol-prefix - Ordered list item prefix

MD029:

# List style

style: "one_or_ordered"

# MD030/list-marker-space - Spaces after list markers

MD030:

# Spaces for single-line unordered list items

ul_single: 1

# Spaces for single-line ordered list items

ol_single: 1

# Spaces for multi-line unordered list items

ul_multi: 1

# Spaces for multi-line ordered list items

ol_multi: 1

# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines

MD031:

# Include list items

list_items: true

# MD032/blanks-around-lists - Lists should be surrounded by blank lines

MD032: true

# MD033/no-inline-html - Inline HTML

# NOTE: Some content like Logger '<module>' triggers false positives

MD033: false

# MD034/no-bare-urls - Bare URL used

MD034: true

# MD035/hr-style - Horizontal rule style

MD035:

# Horizontal rule style

style: "consistent"

# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading

# NOTE: We use **<topic>** instead of yet another sub-heading that might not appear in the navigation.

# this is a trade-off we make to not a gigantic right-navigation

MD036: false

# MD037/no-space-in-emphasis - Spaces inside emphasis markers

MD037: true

# MD038/no-space-in-code - Spaces inside code span elements

# mkdocs-material requires these in tab content

MD038: false

# MD039/no-space-in-links - Spaces inside link text

MD039: true

# MD040/fenced-code-language - Fenced code blocks should have a language specified

MD040: true

# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading

MD041:

# Heading level

level: 2

# RegExp for matching title in front matter

front_matter_title: "^\\s*title\\s*[:=]"

# MD042/no-empty-links - No empty links

# NOTE: Clipboard links like Lambda Layers use empty links

MD042: false

# MD043/required-headings/required-headers - Required heading structure

# NOTE: Enforce our minimum headers across the docs

MD043:

# List of headings

headings:

[

"*",

"## Key features",

"*",

"## Getting started",

"*",

"## Advanced",

"*",

"## Testing your code",

"*",

]

# MD044/proper-names - Proper names should have the correct capitalization

MD044:

# List of proper names

names: []

# Include code blocks

code_blocks: true

# Include HTML elements

html_elements: true

# MD045/no-alt-text - Images should have alternate text (alt text)

MD045: true

# MD046/code-block-style - Code block style

# Material theme tabbed content feature use indented and simple use fenced; can't support both

MD046: false

# MD047/single-trailing-newline - Files should end with a single newline character

MD047: true

# MD048/code-fence-style - Code fence style

MD048: false

# MD051/link-fragments - Link fragments should be valid

MD051: true

# MD052/reference-links-images - Reference links and images should use a label that is defined

MD052: true

# MD053/link-image-reference-definitions - Link and image reference definitions should be needed

MD053: true