Skip to content

Question about the linter rules #41350

@Marvin-Brouwer

Description

@Marvin-Brouwer

Code of Conduct

What article on docs.github.com is affected?

Hi,

I'm reading this article: https://github.com/github/docs/tree/main/src/content-linter, and, I have a question.
The article is explaining how you can "contribute to the content linter code by adding new rules".

I am almost 90% certain that this article is illustrating how to make a contribution to the site-wide markdown linter.
However, the way this article is written, it almost looks like I can also just add a file to src/content-linter/lib/linting-rules/* in any of my repo's and have additional rules specific to my repo.

Did I read that right? Can I add repo-specific linting rules?
Or is this just meant to extends the site's markdown linter for the inline editor?

Thanks,
Marvin.

What part(s) of the article would you like to see updated?

I'm not sure yet, I'd like to have my question answered before I can say that.

Additional information

If I am building a custom linter, e.g: a remark plugin, and there currently isn't a way to integrate that into my GitHub markdown linter.
Where would I request such a feature?

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions