Skip to content

lintMarkdownContent

Lints markdown content that is not on disk, with the configuration lint:md would have used for it.

Import:

import { lintMarkdownContent } from '@mnaoumov/typescript-dev-toolkit/linters/markdownlint-content';

Signature:

function lintMarkdownContent(params: LintMarkdownContentParams): Promise<string[]>

Parameters:

Parameter Type Description
params LintMarkdownContentParams The LintMarkdownContentParams.

Returns: Promise<string[]> — A Promise that resolves to the findings, each one the line the lint:md output would have carried — <path>:<line>[:<column>] error <rule> <description> — or an empty array when there are none.


Links to this page: