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

I cannot install mdx-mermaid plugin #64

Closed
alexandrehtrb opened this issue Aug 10, 2022 · 2 comments
Closed

I cannot install mdx-mermaid plugin #64

alexandrehtrb opened this issue Aug 10, 2022 · 2 comments

Comments

@alexandrehtrb
Copy link

Describe the bug
I cannot setup the mdx-mermaid plugin in my Docusaurus website.

To Reproduce

  1. npx create-docusaurus@latest my-website classic --typescript
  2. npm install mdx-mermaid mermaid
  3. In the docusaurus.config.js file, in the config object, add the plugin:
const config = {
  ...
  plugins: ['mdx-mermaid']
}
  1. npm start

Stack trace

npm WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.

> my-website@0.0.0 start
> docusaurus start

[INFO] Starting the development server...
[ERROR] Error [ERR_REQUIRE_ESM]: require() of ES Module C:\PROJETOS\TesteDocusaurus\my-website\node_modules\mdx-mermaid\lib\mdxast-mermaid.js from C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\plugins\configs.js not supported.
Instead change the require of mdxast-mermaid.js in C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\plugins\configs.js to a dynamic import() which is available in all CommonJS modules.
    at module.exports (C:\PROJETOS\TesteDocusaurus\my-website\node_modules\import-fresh\index.js:32:59)
    at normalizePluginConfig (C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\plugins\configs.js:20:57)
    at C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\plugins\configs.js:99:60
    at Array.map (<anonymous>)
    at loadPluginConfigs (C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\plugins\configs.js:99:38)
    at async initPlugins (C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\plugins\init.js:42:27)
    at async loadPlugins (C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\plugins\index.js:26:21)
    at async load (C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\server\index.js:76:58)
    at async Command.start (C:\PROJETOS\TesteDocusaurus\my-website\node_modules\@docusaurus\core\lib\commands\start.js:42:19)
[INFO] Docusaurus version: 2.0.1
Node version: v16.16.0

Additional context
I tried to follow the tutorial, but an error shows up regarding "remarkPlugins" not being a valid field.

@sjwall
Copy link
Owner

sjwall commented Aug 10, 2022

Hey, looks like you're using the v2 rc1 release which has slightly different configuration https://sjwall.github.io/mdx-mermaid/docs/next/intro/

This might be why you're getting an error with remarkPlugins

There's a working example here https://github.com/sjwall/mdx-mermaid/blob/main/doc/docusaurus.config.js

@alexandrehtrb
Copy link
Author

It worked! Thanks man!

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