Package Exports

@textlint/textlint-plugin-markdown
@textlint/textlint-plugin-markdown/lib/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@textlint/textlint-plugin-markdown) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@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

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

License

MIT