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

chore: upgrade docusaurus to v3.0.1 #589

Merged
merged 3 commits into from
Dec 28, 2023
Merged

chore: upgrade docusaurus to v3.0.1 #589

merged 3 commits into from
Dec 28, 2023

Conversation

diwakergupta
Copy link
Member

Fixes #566.

Description

This is a breaking change, for details see
https://docusaurus.io/blog/releases/3.0

  1. Motivation for change?
    Docusaurus v2.x is no longer supported and will be EOL in January.

  2. What was changed?
    Mostly just dependencies. Some markdown changes required to keep MDX3 happy.

Note that _commands.md is in a funky state - it's checked-in, but it is also
auto-generated. My code block PR wasn't sufficient, I had to make some more changes
locally to keep the parser happy. These need to be propagated back to stacks.js.

Checklist

Fixes #566.

This is a breaking change, for details see
https://docusaurus.io/blog/releases/3.0
Copy link

vercel bot commented Dec 18, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 28, 2023 5:49pm

@diwakergupta
Copy link
Member Author

Build is currently failing with:

docs/references/_commands.md"
Cause: Could not parse expression with acorn
Details:
{
  "cause": {
    "pos": 3323,
    "loc": {
      "line": 90,
      "column": 16
    }
  },
  "column": 17,
  "message": "Could not parse expression with acorn",
  "line": 90,
  "name": "90:17",
  "place": {
    "line": 90,
    "column": 17,
    "offset": 3323
  },
  "reason": "Could not parse expression with acorn",
  "ruleId": "acorn",
  "source": "micromark-extension-mdx-expression",
  "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#could-not-parse-expression-with-acorn"
}

I think some more changes are required to argparse.ts in stacks.js/cli

diwakergupta added a commit to hirosystems/stacks.js that referenced this pull request Dec 20, 2023
For some reason, MDX is still unhappy about the code blocks
(see hirosystems/docs#589)

This fixes it, I'm not quite sure why though.
janniks pushed a commit to hirosystems/stacks.js that referenced this pull request Dec 21, 2023
For some reason, MDX is still unhappy about the code blocks
(see hirosystems/docs#589)

This fixes it, I'm not quite sure why though.
Copy link
Contributor

@rafaelcr rafaelcr left a comment

Choose a reason for hiding this comment

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

LGTM 🏁

@diwakergupta diwakergupta merged commit d9aa5ca into main Dec 28, 2023
4 checks passed
@diwakergupta diwakergupta deleted the chore/upgrade branch December 28, 2023 21:05
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.

Upgrade to Docusaurus v3
2 participants