mirror of
https://github.com/open-policy-agent/opa.git
synced 2026-08-12 19:32:48 -06:00
Charlie Egan
b29b1dad76
* Add markdownlint tooling to docs Install markdownlint-cli2 with configuration file and make targets for auto fix etc too. Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Autofixable markdown issues mainly, replace tabs with spaces for consistent 2-space indentation Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD059 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Fix a number of <link> issues Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD041 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD041 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD046 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD025 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD052 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD028 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD001 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Add GH action check in PRs Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Use 4 spaces for tabs Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Use 4 spaces for tabs Signed-off-by: Charlie Egan <charlie_egan@apple.com> * docs: Add spell checking using Vale Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Correct comment for space indentation rule Signed-off-by: Charlie Egan <charlie_egan@apple.com> --------- Signed-off-by: Charlie Egan <charlie_egan@apple.com>
41 lines
1.1 KiB
JSON
41 lines
1.1 KiB
JSON
{
|
|
// Configuration for markdownlint-cli2
|
|
"config": {
|
|
// Use default rules with some exceptions
|
|
"default": true,
|
|
// Allow inline HTML (common in documentation)
|
|
"MD033": false,
|
|
// Allow long lines (code blocks and tables can be long)
|
|
"MD013": false,
|
|
// Allow multiple headers with the same content (Docusaurus indexes duplicates for us)
|
|
"MD024": false,
|
|
// Allow emphasis as heading
|
|
"MD036": false,
|
|
// Allow fenced code blocks without blank lines around them
|
|
"MD031": false,
|
|
// Allow fenced code blocks without language specified
|
|
"MD040": false,
|
|
// Configure hard tabs to convert to spaces, can be auto fixed
|
|
"MD010": {
|
|
"spaces_per_tab": 4
|
|
},
|
|
// Configure MD025 to ignore frontmatter titles
|
|
"MD025": {
|
|
"front_matter_title": ""
|
|
}
|
|
},
|
|
"globs": [
|
|
"**/*.md"
|
|
],
|
|
"ignores": [
|
|
"node_modules",
|
|
"build",
|
|
".docusaurus",
|
|
// Imported from other repos, should not be checked
|
|
"projects/regal",
|
|
"docs/cheatsheet.md",
|
|
"docs/style-guide.md",
|
|
// Auto-generated, should not be checked
|
|
"docs/cli.md"
|
|
]
|
|
} |