Markdown body text check types on Katalyst Documentation

Code fence language required

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: markdown_code_fence_language_required

Purpose#

Require that opening fenced code blocks include a language tag.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: markdown_code_fence_language_required

No heading level jumps

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: markdown_no_heading_level_jumps

Purpose#

Disallow jumps larger than one heading level (for example H1 -> H3).

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: markdown_no_heading_level_jumps

Required section

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: markdown_required_section

Purpose#

Require that a heading with specific text exists somewhere in the body.

Configuration keys#

Field	Required	Default	Meaning
`heading`	yes	-	Heading text that must appear.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: markdown_required_section
 heading: Summary

Requires H1

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: markdown_requires_h1

Purpose#

Require at least one H1 heading in the markdown body.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: markdown_requires_h1

Single H1

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: markdown_single_h1

Purpose#

Require that the markdown body contains at most one H1 heading.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: markdown_single_h1

Title matches H1

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: markdown_title_matches_h1

Purpose#

Require a frontmatter field to match the first H1 heading in the body.

Configuration keys#

Field	Required	Default	Meaning
`field`	no	`title`	Frontmatter key compared to the first H1.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: markdown_title_matches_h1
 field: title

Worked example#

The markdown_title_matches_h1 check ties a frontmatter field to the document’s first H1. When they disagree, check reports the mismatch and exits 1.

Writing tells

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: markdown_writing_tells

Severity: warning, reported for review; never fails a run.

Purpose#

Warn on likely AI-writing tells (em dashes, decorative emoji, overused words, stock phrases) for human review.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: markdown_writing_tells