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

Move to Docusaurus v3.x #847

Merged
merged 20 commits into from
Apr 10, 2024
Merged

Move to Docusaurus v3.x #847

merged 20 commits into from
Apr 10, 2024

Conversation

andrewnicols
Copy link
Member

This is a series of commits to allow us to migrate to Docusaurus 3.x

Copy link

netlify bot commented Jan 3, 2024

Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit ebbdd96
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/6616a3b373cd5a00082250dc
😎 Deploy Preview https://deploy-preview-847--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@andrewnicols
Copy link
Member Author

Note: I haven't got the jest tests working yet. I'm going to defer that to another issue because it's not critical. It's just testing one set of remark features.

@andrewnicols andrewnicols force-pushed the docusaurusv3 branch 3 times, most recently from 02ccc24 to 6ffbb2c Compare January 3, 2024 07:17
Copy link
Contributor

github-actions bot commented Jan 3, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 89 🟢 95 🟢 100 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🟠 77 🟢 93 🟢 100 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 84 🟢 95 🟢 100 🟢 90 🟢 100 Report
/general/releases 🟠 80 🟢 95 🟢 100 🟢 100 🟢 100 Report

@andrewnicols andrewnicols marked this pull request as ready for review January 3, 2024 13:19
@andrewnicols andrewnicols requested a review from sarjona January 5, 2024 07:56
Copy link
Member

@sarjona sarjona left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrewnicols , thanks for working on this. I love the way you organised the commits because it was easy to understand and follow them. Well done!
The changes look great and it is amazing we can upgrade to docusaurus 3! Good job!! <3
I'm super-happy to approve this!

@sarjona
Copy link
Member

sarjona commented Jan 29, 2024

@andrewnicols although the patch is ready, I was wondering whether we should warn developers about this upgrade (because dependencies like Node will change).
Feel free to merge it once you think we're good to go :-)

We should use backticks and not curly braces for descriptors in
markdown. We do not support the markdown terms feature, which is not
even a feature of extended markdown.
When any JSX is used (import/export), it must be followed by at least
one empty line before and MDX is used, whether that is Markdown, or a
React component.

https://mdxjs.com/docs/troubleshooting-mdx/#could-not-parse-importexports-with-acorn-error
mdx2 is stricter and will fail on a number of sillier things which
mdx2 was more liberal with:

- Use of `<` - used to open JSX tags
  https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3#bad-usage-of--1
- Use of `{` - used to open JS expressions in JSX
  https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3#bad-usage-of-
@andrewnicols andrewnicols added this pull request to the merge queue Apr 10, 2024
Merged via the queue into moodle:main with commit 803a167 Apr 10, 2024
6 of 7 checks passed
@andrewnicols andrewnicols deleted the docusaurusv3 branch April 10, 2024 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants