Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lint docs #1708

Open
alexeyr-ci opened this issue Mar 8, 2025 · 0 comments
Open

Lint docs #1708

alexeyr-ci opened this issue Mar 8, 2025 · 0 comments

Comments

@alexeyr-ci
Copy link
Collaborator

alexeyr-ci commented Mar 8, 2025 •
edited by alexeyr-ci2
Loading

Since we use Gatsby to build the website, and it uses Remark to process Markdown, https://github.com/remarkjs/remark-lint should check its validity.

It should include a custom rule to ban relative links inside docs, see https://github.com/shakacode/react_on_rails/blob/c2993d2550950bdbcfe012a2c034eadd6c8eb923/docs/contributor-info/pull-requests.md#links-to-other-docs.

Alternative (maybe for additional rules): https://github.com/DavidAnson/markdownlint
@alexeyr-ci2 alexeyr-ci2 changed the title Add Markdownlint to CI Lint docs Apr 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alexeyr-ci