[GH-ISSUE #133] More documentation on how to include a custom rule, please #1960

New issue

Closed

opened 2026-03-07 20:03:10 +03:00 by kerem · 1 comment

kerem commented

2026-03-07 20:03:10 +03:00

Owner

Originally created by @JoshuaKGoldberg on GitHub (Jul 15, 2018).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/133

Continuing https://github.com/igorshubovych/markdownlint-cli/issues/41: there's no documentation on what structure a repository that contains a custom rule should have.

I'm working on one now and can probably fix this soon.

Originally created by @JoshuaKGoldberg on GitHub (Jul 15, 2018). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/133 Continuing https://github.com/igorshubovych/markdownlint-cli/issues/41: there's no documentation on what structure a repository that contains a custom rule should have. I'm working on one now and can probably fix this soon.

kerem

2026-03-07 20:03:10 +03:00

closed this issue
added the
question

fixed in next
labels

kerem commented

2026-03-07 20:03:11 +03:00

Author

Owner

@DavidAnson commented on GitHub (Jul 15, 2018):

The custom rule document (https://github.com/DavidAnson/markdownlint/blob/master/doc/CustomRules.md) includes a link to https://github.com/DavidAnson/markdownlint/blob/master/test/rules/package.json which should be helpful?

@DavidAnson commented on GitHub (Jul 15, 2018): The custom rule document (https://github.com/DavidAnson/markdownlint/blob/master/doc/CustomRules.md) includes a link to https://github.com/DavidAnson/markdownlint/blob/master/test/rules/package.json which should be helpful?

kerem referenced this issue

2026-03-07 20:09:35 +03:00

[GH-ISSUE #1960] a #2638