Madness (madness.yml) (SchemaStore) JSON Schema

Type	object
File match	`madness.yml` `madness.yaml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/madness-madness-yml/latest.json
Source	https://raw.githubusercontent.com/DannyBen/madness/master/schemas/madness.json

Validate with Lintel

npx @lintel/lintel check

Type: object

Settings for madness server https://madness.dannyb.co/#configuration-file

Properties

path string

Path to the documentation root https://madness.dannyb.co/#configuration-file

Default: "."

minLength=1

port integer

Server port https://madness.dannyb.co/#configuration-file

Default: "3000"

min=0

bind string

Server listening address https://madness.dannyb.co/#configuration-file

Default: "0.0.0.0"

pattern=^\d+\.\d+\.\d+\.\d+$

renderer string

The underlying markdown renderer to use https://madness.dannyb.co/#configuration-file

Default: "redcarpet"

Values: "redcarpet" "pandoc"

base_uri string | null

Server root URI https://madness.dannyb.co/#configuration-file

sort_order string

Navigation sort order https://madness.dannyb.co/#configuration-file

Default: "dirs_first"

Values: "dirs_first" "mixed"

auto_h1 boolean

Whether to add H1 title to files that do not have one https://madness.dannyb.co/#configuration-file

Default: "true"

auto_nav boolean

Whether to append navigation to directory READMEs https://madness.dannyb.co/#configuration-file

Default: "true"

auto_toc boolean

Whether to enable table of contents https://madness.dannyb.co/#configuration-file

Default: "true"

highlighter boolean

Whether to enable syntax highlighter for code snippets https://madness.dannyb.co/#configuration-file

Default: "true"

mermaid boolean

Whether to enable support for mermaid diagrams https://madness.dannyb.co/#configuration-file

Default: "true"

copy_code boolean

Whether to enable the copy to clipboard icon for code snippets https://madness.dannyb.co/#configuration-file

Default: "true"

shortlinks boolean

Whether to convert [[Links]] to Links https://madness.dannyb.co/#configuration-file

Default: "false"

toc string | null

Whether to generate a table of contents file with this name https://madness.dannyb.co/#configuration-file

theme string | null

Theme directory https://madness.dannyb.co/#configuration-file

source_link string | null

Template for source code links https://madness.dannyb.co/#configuration-file

source_link_label string

Label for the page source code link https://madness.dannyb.co/#configuration-file

Default: "Page Source"

minLength=1

source_link_pos string

The position of the page source code link https://madness.dannyb.co/#configuration-file

Default: "bottom"

Values: "top" "bottom"

open boolean

Whether to open the server URL in the browser https://madness.dannyb.co/#configuration-file

Default: "false"

auth boolean | string

Whether to provide user:password for basic authentication https://madness.dannyb.co/#configuration-file

auth_zone string

An auth realm name https://madness.dannyb.co/#configuration-file

Default: "Restricted Documentation"

expose_extensions string | null

Show files with these extensions in the navigation https://madness.dannyb.co/#configuration-file

exclude string[]

Excluded directories https://madness.dannyb.co/#configuration-file

minItems=1uniqueItems=true