Markdown linting helpers for Electron org repos
npm install @electron/lint-roller
> Markdown linting helpers for Electron org repos
``bash
yarn global add @electron/lint-roller
lint-roller-markdown-links --root docs/ "docs/*/.md"
`
A base config for markdownlint is provided for consistent linting rules.markdownlint.json
across repos. To use the base config, extend it in :
`json`
{
"extends": "@electron/lint-roller/configs/markdownlint.json"
}
lint-roller-markdown-links is a command to further lint links to find--fetch-external-links
broken relative links, including URL fragments, and can also be used to
check external links with the option.
lint-roller-markdown-standard is a command to lint JS code blocks instandard
Markdown with , like standard-markdown does, but with better@nolint
detection of code blocks. Linting can be disabled for specific code blocks
by adding to the info string.
lint-roller-markdown-ts-check is a command to type check JS/TS code blockstsc
in Markdown with . Type checking can be disabled for specific code blocks@ts-nocheck
by adding to the info string, specific lines can be ignored by@ts-expect-error=[
adding to the info string, and additional@ts-type={name:type}
globals can be defined with . The Window object can@ts-window-type={name:type}
be extended with more types using . When typedeclare global
checking TypeScript blocks in the same Markdown file, global augmentation
(via ) can be shared between code blocks by putting@ts-noisolate` on the code block doing the global augmentation.
MIT