Class Markdownlint

Hierarchy

  • Component
    • Markdownlint

Constructors

constructor

Properties

ignoreFile? options project rules defaultRules

Methods

addIgnorePattern postSynthesize preSynthesize synthesize of

Constructors

constructor

Properties

Optional Readonly ignoreFile

ignoreFile?: IgnoreFile

The .markdownlintignore file.

Readonly options

options: MarkdownlintOptions

Readonly project

project: GitHooksEnabledProject

rules

rules: MarkdownlintRules

Direct access to the markdownlint rules (escape hatch)

Static defaultRules

defaultRules: {
    MD013: {
        codeBlockLineLength: number;
        codeBlocks: boolean;
        headers: boolean;
        headingLineLength: number;
        headings: boolean;
        lineLength: number;
        stern: boolean;
        strict: boolean;
        tables: boolean;
    };
    MD024: {
        allowDifferentNesting: boolean;
        siblingsOnly: boolean;
    };
} = ...

Type declaration

  • MD013: {
        codeBlockLineLength: number;
        codeBlocks: boolean;
        headers: boolean;
        headingLineLength: number;
        headings: boolean;
        lineLength: number;
        stern: boolean;
        strict: boolean;
        tables: boolean;
    }
    • codeBlockLineLength: number
    • codeBlocks: boolean
    • headers: boolean
    • headingLineLength: number
    • headings: boolean
    • lineLength: number
    • stern: boolean
    • strict: boolean
    • tables: boolean
  • MD024: {
        allowDifferentNesting: boolean;
        siblingsOnly: boolean;
    }
    • allowDifferentNesting: boolean
    • siblingsOnly: boolean

Methods

addIgnorePattern

  • Defines Markdownlint ignore Patterns these patterns will be added to the file .markdownlintignore

    Parameters

    • pattern: string

      filepatterns so exclude from Markdownlint formatting

    Returns void

postSynthesize

  • Called after synthesis. Order is not guaranteed.

    Returns void

preSynthesize

  • Returns void

synthesize

  • Synthesizes files to the project output directory.

    Returns void

Static of

  • Returns the singletone component of a project or undefined if there is none.

    Parameters

    • project: Project

    Returns undefined | Markdownlint

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc