Rules#

gomarklint currently runs the following checks (ordered as executed):

Rule key	What it detects	Notes / Options
`final-blank-line`	Missing final blank line at EOF	Default on
`unclosed-code-block`	Unclosed fenced code blocks (```)	Default on
`empty-alt-text`	Image syntax with an empty alt text	Default on
`heading-level`	Invalid heading level progression (e.g., H2 → H4 skip)	Default on. Option: `minLevel` (default `2`)
`fenced-code-language`	Fenced code blocks without a language identifier	Default on
`duplicate-heading`	Duplicate headings within one file	Default on
`no-multiple-blank-lines`	Multiple consecutive blank lines	Default on
`no-setext-headings`	Setext heading used instead of ATX style	Default on
`single-h1`	More than one H1 heading in a file	Default on
`blanks-around-headings`	Headings not surrounded by blank lines	Default on
`no-bare-urls`	HTTP/HTTPS URLs written as bare text instead of proper Markdown links	Default on
`no-empty-links`	Links or images with an empty destination (`[]()`, `[](#)`, `[](<>)`)	Default on
`no-emphasis-as-heading`	Bold/italic text used as a heading substitute instead of ATX headings	Default on. Punctuation-ending spans (`. , ; : ! ? 。、；：！？`) are excluded
`blanks-around-lists`	Lists not surrounded by blank lines	Default on
`blanks-around-fences`	Fenced code blocks not surrounded by blank lines	Default on
`no-hard-tabs`	Hard tab characters (`\t`) outside fenced code blocks and inline code	Default on
`no-trailing-punctuation`	Heading text ending with a punctuation character	Default on. Option: `punctuation` (default `".,;:!"`) — the full set of characters to flag; e.g. set `".,;:!?"` to also flag question headings
`consistent-code-fence`	Inconsistent fenced code block marker (``` vs `~~~`)	Default on. Option: `style` (`consistent` \| `backtick` \| `tilde`, default `consistent`)
`consistent-emphasis-style`	Inconsistent emphasis marker (`text` vs `_text_`)	Default on. Option: `style` (`consistent` \| `asterisk` \| `underscore`, default `consistent`)
`consistent-list-marker`	Inconsistent unordered list marker (`-` vs `*` vs `+`)	Default on. Option: `style` (`consistent` \| `dash` \| `asterisk` \| `plus`, default `consistent`)
`max-line-length`	Lines exceeding the configured maximum length	Default off. Option: `lineLength` (default `80`)
`external-link`	External links that fail HTTP validation	Default off. Options: `timeoutSeconds` (default `5`), `skipPatterns` (regex list)
`link-fragments`	Internal fragment links (`#section`) that do not resolve to a heading	Default off. Options: `slug-algorithm` (default `github`), `slug-params` (for `custom` algorithm)

link-fragments#

link-fragments validates that every internal fragment link in a document resolves to an actual heading slug. It supports multiple slug algorithms to match the platform where the Markdown is published.

slug-algorithm#

Set slug-algorithm to the name of the platform you are writing for. Each platform is an independent named value — you do not need to know which underlying algorithm it maps to.

Supported platforms:

Value	Platform	lowercase	preserve-unicode	space-replacement	strip-chars	collapse-separators	Notes
`github`	GitHub (default)	✓	✓	`-`	Unicode punctuation/symbols	—	`github-slugger`; consecutive spaces → consecutive hyphens
`gitlab`	GitLab	✓	✓	`-`	`[^\p{L}\p{N}_-]`	✓	goldmark slugify; collapses consecutive separators unlike GitHub
`zenn`	Zenn	✓	✓	`-`	preserves all non-space chars	—	`markdown-it-anchor` default; anchors are percent-encoded in HTML
`qiita`	Qiita	✓	✓	`-`	`[^\p{Word}\- ]`	—	`downcase.gsub(/[^\p{Word}\- ]/u, "").tr(" ", "-")`; consecutive hyphens preserved
`hugo`	Hugo	✓	✓	`-`	Unicode punctuation/symbols	—	`autoHeadingIDType: github` (default); equivalent to `github-slugger`
`vitepress`	VitePress	✓	partial	`-`	NFKD, strip combining chars, then punctuation→`-`	✓	Accented Latin normalized to ASCII (é→e); CJK preserved
`docusaurus`	Docusaurus	✓	✓	`-`	Unicode punctuation/symbols	—	Uses `github-slugger` directly
`gatsby`	Gatsby	✓	✓	`-`	Unicode punctuation/symbols	—	`gatsby-remark-autolink-headers` uses `github-slugger`
`astro`	Astro	✓	✓	`-`	Unicode punctuation/symbols	—	Documented as GitHub-compatible in Astro official docs
`starlight`	Starlight	✓	✓	`-`	Unicode punctuation/symbols	—	Starlight (Astro-based); same algorithm as `astro`
`nuxt-content`	Nuxt Content	✓	✓	`-`	Unicode punctuation/symbols	—	Uses `rehype-slug` (github-slugger wrapper)
`pandoc`	Pandoc (`auto_identifiers`)	✓	—	`-`	`[^a-zA-Z0-9_-]`	✓	`auto_identifiers` extension; strips non-ASCII. Non-ASCII-only headings produce an empty slug — links to them cannot be verified statically; see FAQ
`pandoc-gfm`	Pandoc (`gfm_auto_identifiers`)	✓	✓	`-`	Unicode punctuation/symbols	—	`gfm_auto_identifiers` extension; equivalent to GitHub
`quarto`	Quarto	✓	—	`-`	`[^a-zA-Z0-9_-]`	✓	Uses `auto_identifiers` extension by default; same as `pandoc`
`kramdown`	kramdown	✓	—	`-`	`[^a-zA-Z0-9 -]`	✓	`header_ids` extension default. Non-ASCII-only headings produce an empty slug — links to them cannot be verified statically; see FAQ
`mkdocs`	MkDocs	✓	—	`-`	NFKD then ASCII-encode	✓	Python-Markdown `toc.py` default; `uslugify` variant preserves Unicode. Non-ASCII-only headings produce an empty slug — links to them cannot be verified statically; see FAQ
`docfx`	DocFX	—	—	`-`	`[^a-zA-Z0-9-_.]`	✓	Markdig AutoIdentifiers; does not lowercase
`mdbook`	mdBook	✓	✓	`-`	non-alphanumeric except `_` and `-` (Rust `is_alphanumeric()`)	—	CJK preserved via Unicode alphanumeric check
`gitea`	Gitea	✓	✓	`-`	Unicode punctuation/symbols	—	goldmark-based; identical to GitHub algorithm. Gitea adds `user-content-` to the DOM id for CSP isolation, but users write fragments without that prefix (e.g. `#hello-world`)
`forgejo`	Forgejo	✓	✓	`-`	Unicode punctuation/symbols	—	Fork of Gitea; identical algorithm
`sphinx`	Sphinx	✓	—	`-`	NFKD then ASCII then `[^a-z0-9]+`→`-`	✓	Digits-only or non-Latin-only headings produce an empty slug; Sphinx falls back to `id1`, `id2`, … at build time — gomarklint cannot verify links to these headings statically; see FAQ
`eleventy`	Eleventy	✓	—	`-`	`@sindresorhus/slugify` (transliterate to approximate ASCII)	✓	Used via `IdAttributePlugin`. Characters with no ASCII equivalent (CJK, etc.) are stripped — non-ASCII-only headings produce an empty slug; see FAQ
`azure-devops`	Azure DevOps Wiki	✓	✓	`-`	non-RFC-3986-unreserved chars percent-encoded	—	Unicode Zs category → `-`; non-ASCII preserved as percent-encoded
`myst`	MyST Parser	✓	✓	`-`	Unicode punctuation/symbols	—	MyST-Parser (Python/Sphinx); documented as GitHub-compatible
`custom`	—	—	—	—	—	—	Parameterized engine — see below

Custom algorithm#

Use slug-algorithm: "custom" with slug-params for platforms not covered by the built-in presets:

"link-fragments": {
  "enabled": true,
  "slug-algorithm": "custom",
  "slug-params": {
    "lowercase": true,
    "preserve-unicode": true,
    "space-replacement": "-",
    "strip-chars": "[^\\w\\- ]",
    "collapse-separators": true
  }
}

Parameter	Type	Description
`lowercase`	bool	Lowercase the heading before processing (default `true`)
`preserve-unicode`	bool	Keep non-ASCII characters in the slug (default `true`)
`space-replacement`	string	Character to replace spaces — `"-"` or `"_"` (default `"-"`)
`strip-chars`	string	Regex matching characters to remove after space replacement
`collapse-separators`	bool	Collapse consecutive separators and trim leading/trailing (default `false`)

Note: strip-chars uses Go’s regexp syntax. \w matches ASCII [0-9A-Za-z_] only. To match Unicode word characters use \p{L}, \p{N}, etc.

Execution details#

Files/dirs are expanded with ignore patterns from config.
Per-file issues are sorted by line asc before printing.
Line count is computed as \n count + 1 for reporting.