rumdl 0.0.36

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
Documentation 
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

# rumdl.toml.example - Sample configuration file for rumdl

# Global configuration options
[global]
# List of rules to disable
disable = ["MD013", "MD033"]

# List of rules to enable exclusively (if provided, only these rules will run)
# enable = ["MD001", "MD003", "MD004"]

# List of file/directory patterns to exclude from linting
exclude = [
    # Common directories to exclude
    ".git",
    ".github",
    "node_modules",
    "vendor",
    "dist",
    "build",
    
    # Specific files or patterns
    "CHANGELOG.md",
    "LICENSE.md",
    "generated/*.md",
    "**/temp_*.md",
]

# Respect .gitignore files when scanning directories
respect_gitignore = true

# Rule-specific configurations
[MD002]
level = 1  # Expected level for first heading

[MD003]
style = "atx"  # Heading style (atx, atx_closed, setext)

[MD004]
style = "asterisk"  # Unordered list style (asterisk, plus, dash, consistent)

[MD007]
indent = 4  # Unordered list indentation

[MD013]
line_length = 100  # Line length
code_blocks = false  # Exclude code blocks from line length check
tables = false  # Exclude tables from line length check
headings = true  # Exclude headings from line length check

[MD044]
names = ["rumdl", "Markdown", "GitHub"]  # Proper names that should be capitalized correctly
code_blocks_excluded = true  # Exclude code blocks from proper name check