mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-21 08:20:12 +01:00
44 lines
962 B
Markdown
44 lines
962 B
Markdown
# `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>.
|