generated from okp4/template-oss
-
Notifications
You must be signed in to change notification settings - Fork 25
Open
Description
Context
As our Docusaurus documentation continues to grow, we have incorporated a significant number of pages written in MDX format. To ensure that our MDX pages meet quality standards, we need to implement/setup an MDX linter into our CI workflow.
Scope
Introduce an MDX linter to the CI pipeline, similar to the one we already have for markdown files. The linter should analyze the MDX files during the CI process and provide feedback on adherence to style guidelines.
Todo
- Research available MDX linters and assess their compatibility for integration with our current CI, and check whether they can also be invoked from the command line.
- Create a new CI job named
lint-mdx
responsible for running the selected linter on all MDX files within thedocs/
directory. - Address any errors or issues identified by the linter, ensuring that the
lint-mdx
job produces successful outcomes (green status). - Optionally, investigate the possibility of launching the linter execution via the
yarn
command (declared in thepackage.json
file).
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
📆 To do