Skip to content

Ensure that code block inside list doesn't split the list

License

Notifications You must be signed in to change notification settings

ilyatitovich/remark-lint-code-block-split-list

Repository files navigation

remark-lint-code-block-split-list

remark-lint plugin to ensure that code block inside list doesn't split the list.

The plugin checks if the code block split the list (сode block is incorrectly indented).

Install

npm install remark-lint-code-block-split-list

Usage

Use like any other remark-lint plugin. Check out the remark-lint documentation for details.

Examples

When this rule is turned on, the following valid.md is ok:

1. Item 1

   ```sh
   pnpm run dev
   ```

2. Item 2

When this rule is turned on, the following invalid.md is not ok:

1. Item 1

```sh
pnpm run dev
```

2. Item 2
6:1-8:4 warning Add 3 spaces to the beginning of the code block to align with the list. code-block-split-list remark-lint

Support the Project

If you find this tool helpful, consider supporting us:

About

Ensure that code block inside list doesn't split the list

Resources

License

Stars

Watchers

Forks