@textmode/markdownlint-config

Shared markdownlint configuration for textmode.js Markdown files.

This package encodes the Markdown conventions used across the textmode.js ecosystem, including heading style, fenced code blocks, table formatting, allowed inline HTML, and preferred brand casing.

Installation

npm install -D @textmode/markdownlint-config markdownlint-cli2

Usage

Create a markdownlint config that extends the package config:

// .markdownlint.jsonc
{
	"extends": "./node_modules/@textmode/markdownlint-config/index.jsonc",
}

Then configure markdownlint-cli2 for the repository:

// .markdownlint-cli2.jsonc
{
	"globs": ["**/*.md"],
	"ignores": ["node_modules/**", "dist/**", "api/**", "**/CHANGELOG.md"],
	"fix": false,
	"outputFormatters": [["markdownlint-cli2-formatter-default"]],
}

Run it from a package script:

{
	"scripts": {
		"lint:md": "markdownlint-cli2"
	}
}

What It Includes

• ATX headings.
• Dash unordered lists.
• Ordered lists with ordered numbering.
• Fenced code blocks with language identifiers.
• A relaxed line length rule for prose-heavy documentation.
• Tabs allowed, matching textmode.js code formatting.
• Inline HTML allowlist for documentation tables, images, and generated content.
• Preferred casing for textmode.js, TypeScript, JavaScript, WebGL, WebGL2, Node.js, GitHub, npm, ASCII, GLSL, and PETSCII.

Notes

Use project-level .markdownlint-cli2.jsonc ignores for generated API docs, examples, changelogs, and other content that should not follow hand-authored documentation rules.