Add MDX linter for docs directory. #12925

Closed
opened 2025-11-02 10:25:11 -06:00 by GiteaMirror · 2 comments
Owner

Originally created by @lunny on GitHub (Apr 28, 2024).

Since Gitea's documentation are now building with docusaurus v3 which support MDX syntax. So some wrong syntax will break the documentation building. Maybe https://npmjs.org/eslint-plugin-mdx is a good choice.

Originally created by @lunny on GitHub (Apr 28, 2024). Since Gitea's documentation are now building with docusaurus v3 which support MDX syntax. So some wrong syntax will break the documentation building. Maybe https://npmjs.org/eslint-plugin-mdx is a good choice.
GiteaMirror added the topic/build label 2025-11-02 10:25:11 -06:00
Author
Owner

@silverwind commented on GitHub (Apr 29, 2024):

Would mdx files be named .mdx? If so, we can distinguish by file extension for which linters run on what. Would not recommend putting MDX content into .md.

Also I think that eslint plugin runs based on remark, not markdownlint which we currently use. Maybe we should migrate to remark so linting of mdx and md is similar.

@silverwind commented on GitHub (Apr 29, 2024): Would mdx files be named `.mdx`? If so, we can distinguish by file extension for which linters run on what. Would not recommend putting MDX content into `.md`. Also I think that eslint plugin runs based on remark, not markdownlint which we currently use. Maybe we should migrate to remark so linting of mdx and md is similar.
Author
Owner

@lunny commented on GitHub (Aug 23, 2024):

This can be closed as docs moved to https://gitea.com/gitea/docs.

@lunny commented on GitHub (Aug 23, 2024): This can be closed as docs moved to https://gitea.com/gitea/docs.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#12925