Generate Rules.md and md###.md files from metadata, improve Parameters documentation by referencing schema.

This commit is contained in:
David Anson 2022-10-29 23:21:45 -07:00
parent 32c75ebfd9
commit 37baddcf27
110 changed files with 3875 additions and 179 deletions

44
doc/md040.md Normal file
View file

@ -0,0 +1,44 @@
# MD040 - Fenced code blocks should have a language specified
Tags: code, language
Aliases: fenced-code-language
Parameters:
* `allowed_languages`: List of languages (`string[]`, default `[]`)
This rule is triggered when fenced code blocks are used, but a language isn't
specified:
````markdown
```
#!/bin/bash
echo Hello world
```
````
To fix this, add a language specifier to the code block:
````markdown
```bash
#!/bin/bash
echo Hello world
```
````
To display a code block without syntax highlighting, use:
````markdown
```text
Plain text in a code block
```
````
You can configure the `allowed_languages` parameter to specify a list of
languages code blocks could use. The default value is `[]` which means any
language specifier is valid.
Rationale: Specifying a language improves content rendering by using the
correct syntax highlighting for code. More information:
<https://cirosantilli.com/markdown-style-guide#option-code-fenced>.