@textlint/textlint-plugin-markdown
TypeScript icon, indicating that this package has built-in type declarations

14.0.4 • Public • Published

@textlint/textlint-plugin-markdown

Markdown support for textlint.

Installation

npm install @textlint/textlint-plugin-markdown

Usage

Built-in support on textlint. No need configuration.


Following config is set by default.

{
    "plugins": {
        "@textlint/markdown": true
    }
}

Options

  • extensions: string[]
    • Additional file extensions for markdown

For example, if you want to treat MDX as markdown, put following config to .textlintrc

{
    "plugins": {
        "@textlint/markdown": {
            "extensions": [".mdx"]
        }
    }
}

Tests

npm test

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT

Package Sidebar

Install

npm i @textlint/textlint-plugin-markdown

Weekly Downloads

57,585

Version

14.0.4

License

MIT

Unpacked Size

98.6 kB

Total Files

23

Last publish

Collaborators

  • textlint-user
  • azu
  • 0x6b