rumdl 0.2.75

A fast Markdown linter and formatter written in Rust
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
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

# =============================================================================
# rumdl Documentation - Zensical Configuration
# =============================================================================

[project]
site_name = "rumdl"
site_description = "A fast Markdown linter and formatter written in Rust"
site_author = "Ruben Jongejan"
site_url = "https://rumdl.dev/"
copyright = """
Copyright © 2024-2026 Ruben Jongejan
"""

# Repository settings for edit links
repo_url = "https://github.com/rvben/rumdl"
edit_uri = "blob/main/docs/"
repo_name = "rvben/rumdl"

# Navigation structure - references existing files directly
nav = [
  { "Home" = "index.md" },
  { "Getting Started" = [
    { "Installation" = "getting-started/installation.md" },
    { "Quick Start" = "getting-started/quickstart.md" },
  ]},
  { "Usage" = [
    { "CLI Commands" = "usage/cli.md" },
    { "Editor Integration" = "usage/editors.md" },
    { "CI/CD Integration" = "usage/ci-cd.md" },
    { "Pre-commit" = "usage/pre-commit.md" },
  ]},
  { "Configuration" = [
    "configuration/index.md",
    { "Global Settings" = "global-settings.md" },
    { "Inline Configuration" = "inline-configuration.md" },
    { "Markdown Flavors" = "flavors.md" },
    { "Code Block Tools" = "code-block-tools.md"},
  ]},
  { "Rules" = "rules.md" },
  { "Playground" = "playground.md" },
  { "Integrations" = [
    { "LSP Server" = "lsp.md" },
    { "VS Code" = "vscode-extension.md" },
  ]},
  { "Reference" = [
    { "Output Formats" = "output-formats.md" },
    { "Stability and Compatibility" = "stability.md" },
    { "Benchmarks" = "benchmarks.md" },
    { "Tool Comparison" = "comparison.md" },
    { "markdownlint Comparison" = "markdownlint-comparison.md" },
    { "mdformat Comparison" = "mdformat-comparison.md" },
    { "Obsidian Linter Comparison" = "obsidian-linter-comparison.md" },
  ]},
]

# rumdl's product layer: shared design tokens, homepage/playground components,
# accessible theme controls, and mobile drawer focus management.
extra_css = ["stylesheets/rumdl.css"]
extra_javascript = [{ path = "javascripts/rumdl.js", defer = true }]

# -----------------------------------------------------------------------------
# Theme configuration
# -----------------------------------------------------------------------------
[project.theme]
language = "en"
logo = "images/rumdl-logo.svg"
favicon = "images/favicon.svg"
custom_dir = "overrides"

features = [
    "announce.dismiss",
    "content.action.edit",
    "content.action.view",
    "content.code.annotate",
    "content.code.copy",
    "content.code.select",
    "content.footnote.tooltips",
    "content.tabs.link",
    "content.tooltips",
    "navigation.footer",
    "navigation.indexes",
    "navigation.instant",
    "navigation.instant.prefetch",
    "navigation.path",
    "navigation.sections",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
]

# Light/dark mode toggle
[[project.theme.palette]]
scheme = "default"
primary = "custom"
accent = "custom"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
primary = "custom"
accent = "custom"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

# Icons
[project.theme.icon]
repo = "fontawesome/brands/github"

[project.theme.font]
text = "Manrope"
code = "JetBrains Mono"

# -----------------------------------------------------------------------------
# Social links
# -----------------------------------------------------------------------------
[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/rvben/rumdl"

[[project.extra.social]]
icon = "fontawesome/brands/discord"
link = "https://discord.gg/ADTJFSFUyn"

[[project.extra.social]]
icon = "fontawesome/brands/python"
link = "https://pypi.org/project/rumdl/"

[[project.extra.social]]
icon = "fontawesome/brands/rust"
link = "https://crates.io/crates/rumdl"