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

Support for Docusaurus v3 #5

Open
skyfrk opened this issue Nov 29, 2023 · 5 comments
Open

Support for Docusaurus v3 #5

skyfrk opened this issue Nov 29, 2023 · 5 comments

Comments

@skyfrk
Copy link

skyfrk commented Nov 29, 2023

The plugin is currently not compatible with Docusaurus v3.

Steps to reproduce

  1. Create a new docusaurus app npx create-docusaurus@latest my-website classic
  2. Install this plugin.
  3. Try to render a simple plantuml in Markdown:
```plantuml Your title
class SimplePlantUMLPlugin {
    + transform(syntaxTree: AST): AST
}
```
  1. Get an error

Notes

Its probably an issue caused by the migration to MDX v3: https://docusaurus.io/docs/migration/v3#upgrading-mdx

@mstroppel
Copy link
Owner

Shown error is:

Error: MDX compilation failed for file "C:\data\github\remark-local-plantuml-docusaurus\docs\simple.md"
Cause: Cannot handle unknown node `raw`
Details:
Error: Cannot handle unknown node `raw`

@mstroppel
Copy link
Owner

@ksandin already created a workaround for something similar:
shikijs/twoslash#125 (comment)

@mstroppel
Copy link
Owner

I added a workaround for docusaurus v3 in #9
See the main page.

@mstroppel
Copy link
Owner

@ksandin already created a workaround for something similar: shikijs/twoslash#125 (comment)

This fix is used here https://github.com/mstroppel/remark-local-plantuml-docusaurus/tree/fix/hacky-docusaurus-v3-fix
But I would not recommend it, since it is pretty hacky.

@mstroppel
Copy link
Owner

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

No branches or pull requests

2 participants