docs-agent-control/.markdownlint.jsonc at main · agentcontrol/docs-agent-control · GitHub

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
{
    // ================================
    // Markdownlint baseline standards
    // ================================
    // Details and installation available at https://github.com/DavidAnson/vscode-markdownlint
    // Read full rules: https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/Rules.md

    // --- Headings & structure ---
    "MD001": true, // heading-increment
    "MD003": {
        "style": "atx"
    }, // heading-style: # not underlines
    "MD023": true, // headings start at left
    "MD022": true, // blanks-around-headings

    // --- Lists ---
    "MD004": {
        "style": "dash"
    }, // ul-style: use "-" bullets


    // --- Spacing & punctuation ---
    "MD009": {
        "br_spaces": 2
    }, // no-trailing-spaces (allow 2 for hard break)
    "MD010": true, // no-hard-tabs
    "MD012": {
        "maximum": 2
    }, // no-multiple-blanks
    "MD026": {
        "punctuation": ".,;:!"
    }, // no-trailing-punctuation in headings (allow common marks)
    "MD028": false,
    "MD035": {
        "style": "---"
    }, // hr-style: use '---'

    // --- Line length (documentation-friendly) ---
    "MD013": {
        "heading_line_length": 100,
        "code_block_line_length": 99999,
        "tables": false,
        "line_length": 1000
    },

    // --- Links & URLs ---
    "MD039": true, // no-space-in-links
    "MD042": true, // no-empty-links
    "MD053": true, // link/image reference definitions

    // --- Emphasis & code ---
    "MD036": true, // no-emphasis-as-heading
    "MD037": true, // no-space-in-emphasis
    "MD038": false, // no-space-in-code
    "MD040": {
        // fenced-code-language required, with documentation-friendly allowlist
        "allowed_languages": [
            "bash", "sh", "zsh", "console", "shell", "terminal",
            "json", "jsonc", "yaml", "yml", "toml",
            "js", "jsx", "ts", "tsx", "typescript", "javascript", "node",
            "py", "python", "go", "rust", "rb", "php", "java", "kotlin", "swift",
            "c", "cpp", "csharp", "cs", "sql", "html", "xml", "css", "scss",
            "md", "markdown", "powershell", "ps1", "makefile", "dockerfile",
            "mermaid", "text", "output", "env", "tree", "diff", "patch", "ini"
        ]
    },
    "MD046": {
        "style": "fenced"
    }, // code-block-style: fenced
    "MD048": {
        "style": "backtick"
    }, // code-fence-style: backticks ```
    "MD049": {
        "style": "consistent"
    }, // emphasis-style: * or _ consistently
    "MD050": {
        "style": "consistent"
    }, // strong-style: ** or __ consistently
    // --- Allow Mintlify components + other inline HTML ---
    "MD033": false,
    // First line in a file should be a top-level heading - doesn't work with frontmatter
    "MD041": false,
    // --- Names/brands (helps catch casing) ---
    "MD044": {
        "names": [
            "JavaScript",
            "TypeScript",
            "Node.js",
            "GitHub",
            "OpenAI",
            "Galileo",
            "galileo.ai",
            "Mintlify",
            "Agent Control"
        ],
        "code_blocks": false,
        "html_elements": false
    },
    // Table column style
    "MD060": false
}