quarto-dev / quarto-dev/quarto-cli
Test our docusaurus output with a syntax checker
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 41
Description
https://github.com/slorber/docusaurus-mdx-checker
This would work for Docusaurus V3 support
About the tool
A CLI to report potential MDX v3 parsing errors found in your content, using the same setup as Docusaurus v3 uses.
The output should give you an estimate of how many of your documents are incompatible with MDX v3 (Docusaurus flavor).
This tool was created to help Docusaurus v2 users (using MDX v1) upgrade incrementally to Docusaurus v3 (using MDX v3), or estimate the amount of work needed.
Just opening to track the idea and remember when we'll want to go this path
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the docusaurus-mdx-checker CLI and how Quarto produces its Docusaurus output. Define how the checker should be run against that output and what compatibility results should be recorded. Done means the output is checked for MDX v3 parsing issues, with the integration and expected results documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100