Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@
> If you like this package, please give it a star on [GitHub](https://github.com/lumirlumir/npm-eslint-markdown)!⭐<br/>
> Your support helps us improve and maintain the project.

Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️
Lint your Markdown with ESLint.

- Additional rules for use with `@eslint/markdown`.🛠️
- A blazing fast Markdown parser for ESLint.⚡

## Documentation

Expand All @@ -31,6 +34,18 @@ This [`eslint-markdown`](https://github.com/lumirlumir/npm-eslint-markdown#readm

So, we **highly recommend** using the `eslint-markdown` plugin alongside ESLint's built-in Markdown support, `@eslint/markdown`.

## Included Packages

This repository is maintained as a monorepo and includes the following two packages.

### `eslint-markdown` - [Docs](https://eslint-markdown.lumir.page/docs/packages/eslint-markdown) | [Repository](https://github.com/lumirlumir/npm-eslint-markdown/tree/main/packages/eslint-markdown) | [npm](https://www.npmjs.com/package/eslint-markdown)

Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️

### `@eslint-markdown/parser` - [Docs](https://eslint-markdown.lumir.page/docs/packages/parser) | [Repository](https://github.com/lumirlumir/npm-eslint-markdown/tree/main/packages/parser) | [npm](https://www.npmjs.com/package/@eslint-markdown/parser)

A blazing fast Markdown parser for ESLint.⚡

## Code of Conduct

See [Code of Conduct](https://github.com/lumirlumir/.github/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).
Expand Down
273 changes: 268 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@
"test:types": "tsc -b",
"test:unit": "vitest run",
"test:pkg:em": "npm run test -w packages/eslint-markdown",
"build": "npm run build:pkg:em && npm run build:w",
"test:pkg:p": "npm run test -w packages/parser",
"build": "npm run build:pkg:p && npm run build:pkg:em && npm run build:w",
"build:pkg:em": "npm run build -w packages/eslint-markdown",
"build:pkg:p": "npm run build -w packages/parser",
"build:w": "npm run build -w website",
"build:w:vp": "npm run build:vp -w website",
"build:w:em": "npm run build:em -w website",
Expand Down
Loading