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.

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

Implement MDX Linter for CI #283

Open
4 tasks
ccamel opened this issue Jul 31, 2023 · 0 comments
Open
4 tasks

Implement MDX Linter for CI #283

ccamel opened this issue Jul 31, 2023 · 0 comments

Comments

@ccamel
Copy link
Member

ccamel commented Jul 31, 2023

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 the docs/ 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 the package.json file).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📆 To do
Development

No branches or pull requests

2 participants