You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
The text was updated successfully, but these errors were encountered:
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
lint-mdx
responsible for running the selected linter on all MDX files within thedocs/
directory.lint-mdx
job produces successful outcomes (green status).yarn
command (declared in thepackage.json
file).The text was updated successfully, but these errors were encountered: