rspress-plugin-mermaid 0.1.2-beta.0 → 0.1.3-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -1,12 +1,12 @@
1
1
  import path from 'node:path';
2
- import { PresetConfigMutator, RemarkCodeBlockToGlobalComponentPluginFactory, } from 'rspress-plugin-devkit';
2
+ import { PresetConfigMutator, RemarkCodeBlockToGlobalComponentPluginFactory, getCompatComponentPath, } from 'rspress-plugin-devkit';
3
3
  export default function rspressPluginMermaid(options = {}) {
4
4
  const { mermaidConfig = {} } = options;
5
5
  const remarkMermaid = new RemarkCodeBlockToGlobalComponentPluginFactory({
6
6
  components: [
7
7
  {
8
8
  lang: 'mermaid',
9
- componentPath: path.join(__dirname, './components/MermaidRender.tsx'),
9
+ componentPath: path.join(__dirname, './components', getCompatComponentPath(__dirname, 'MermaidRender.tsx')),
10
10
  childrenProvider() {
11
11
  return [];
12
12
  },
package/package.json CHANGED
@@ -1,7 +1,10 @@
1
1
  {
2
2
  "name": "rspress-plugin-mermaid",
3
- "version": "0.1.2-beta.0",
3
+ "version": "0.1.3-beta.0",
4
4
  "description": "Rspress plugin to render mermaid diagrams",
5
+ "files": [
6
+ "dist"
7
+ ],
5
8
  "keywords": [
6
9
  "rspress",
7
10
  "plugin",
@@ -25,7 +28,7 @@
25
28
  "dependencies": {
26
29
  "@rspress/shared": "^1.17.1",
27
30
  "mermaid": "^10.9.0",
28
- "rspress-plugin-devkit": "^0.1.2-beta.0"
31
+ "rspress-plugin-devkit": "^0.1.3-beta.0"
29
32
  },
30
33
  "devDependencies": {
31
34
  "@types/node": "^20.12.5",
package/CHANGELOG.md DELETED
@@ -1,27 +0,0 @@
1
- # rspress-plugin-mermaid
2
-
3
- ## 0.1.2-beta.0
4
-
5
- ### Patch Changes
6
-
7
- - 932dbb7: compat component path
8
- - Updated dependencies [932dbb7]
9
- - rspress-plugin-devkit@0.1.2-beta.0
10
-
11
- ## 0.1.1
12
-
13
- ### Patch Changes
14
-
15
- - 546dcf0: release beta
16
- - 5e28903: fixup publish config
17
- - Updated dependencies [546dcf0]
18
- - Updated dependencies [5e28903]
19
- - rspress-plugin-devkit@0.1.1
20
-
21
- ## 0.1.1-beta.0
22
-
23
- ### Patch Changes
24
-
25
- - 546dcf0: release beta
26
- - Updated dependencies [546dcf0]
27
- - rspress-plugin-devkit@0.1.1-beta.0
@@ -1 +0,0 @@
1
- [{"id":0,"title":"RSPress x Mermaid","content":"#\n\n","routePath":"/","lang":"","toc":[],"domain":"","frontmatter":{},"version":""}]
package/docs/index.md DELETED
@@ -1,10 +0,0 @@
1
- # RSPress x Mermaid
2
-
3
- ```mermaid
4
- flowchart TD
5
- A[Christmas] -->|Get money| B(Go shopping)
6
- B --> C{Let me think}
7
- C -->|One| D[Laptop]
8
- C -->|Two| E[iPhone]
9
- C -->|Three| F[fa:fa-car Car]
10
- ```
package/image.png DELETED
Binary file
package/rspress.config.ts DELETED
@@ -1,9 +0,0 @@
1
- import * as path from 'path';
2
- import { defineConfig } from 'rspress/config';
3
- import mermaid from './src';
4
-
5
- export default defineConfig({
6
- root: path.join(__dirname, 'docs'),
7
- title: 'Rspress x Mermaid Example',
8
- plugins: [mermaid()],
9
- });
@@ -1,55 +0,0 @@
1
- import React, { useEffect, useId, useState } from 'react';
2
-
3
- import mermaid, { type MermaidConfig } from 'mermaid';
4
-
5
- export interface MermaidRendererProps {
6
- code: string;
7
- config?: MermaidConfig;
8
- }
9
-
10
- const MermaidRenderer: React.FC<MermaidRendererProps> = (props) => {
11
- const { code, config = {} } = props;
12
-
13
- const id = useId();
14
-
15
- const [svg, setSvg] = useState('');
16
-
17
- const [renderError, setRenderError] = useState(false);
18
-
19
- async function renderMermaid2SVG() {
20
- // https://github.com/mermaid-js/mermaid/blob/1b40f552b20df4ab99a986dd58c9d254b3bfd7bc/packages/mermaid/src/docs/.vitepress/theme/Mermaid.vue#L53
21
- const hasDarkClass = document.documentElement.classList.contains('dark');
22
-
23
- const mermaidConfig: MermaidConfig = {
24
- securityLevel: 'loose',
25
- startOnLoad: false,
26
- theme: hasDarkClass ? 'dark' : 'default',
27
- ...config,
28
- };
29
-
30
- try {
31
- mermaid.initialize(mermaidConfig);
32
-
33
- const { svg } = await mermaid.render(
34
- id.replace(/:/g, ''),
35
- code as string,
36
- );
37
-
38
- setSvg(svg);
39
- } catch (error) {
40
- setRenderError(true);
41
- }
42
- }
43
-
44
- useEffect(() => {
45
- renderMermaid2SVG();
46
- }, [code]);
47
-
48
- return (
49
- <>
50
- {renderError ? null : <div dangerouslySetInnerHTML={{ __html: svg }} />}
51
- </>
52
- );
53
- };
54
-
55
- export default MermaidRenderer;
package/src/index.ts DELETED
@@ -1,55 +0,0 @@
1
- import path from 'node:path';
2
-
3
- import {
4
- PresetConfigMutator,
5
- RemarkCodeBlockToGlobalComponentPluginFactory,
6
- getCompatComponentPath,
7
- } from 'rspress-plugin-devkit';
8
-
9
- import type { RspressPlugin } from '@rspress/shared';
10
- import type { MermaidConfig } from 'mermaid';
11
- import type { MermaidRendererProps } from './components/MermaidRender';
12
-
13
- interface RspressPluginMermaidOptions {
14
- mermaidConfig?: MermaidConfig;
15
- }
16
-
17
- export default function rspressPluginMermaid(
18
- options: RspressPluginMermaidOptions = {},
19
- ): RspressPlugin {
20
- const { mermaidConfig = {} } = options;
21
-
22
- const remarkMermaid = new RemarkCodeBlockToGlobalComponentPluginFactory({
23
- components: [
24
- {
25
- lang: 'mermaid',
26
- componentPath: path.join(
27
- __dirname,
28
- './components',
29
- getCompatComponentPath(__dirname, 'MermaidRender.tsx'),
30
- ),
31
- childrenProvider() {
32
- return [];
33
- },
34
- propsProvider(code) {
35
- return {
36
- code,
37
- config: mermaidConfig,
38
- } satisfies MermaidRendererProps;
39
- },
40
- },
41
- ],
42
- });
43
-
44
- return {
45
- name: 'rspress-plugin-mermaid',
46
- config(config) {
47
- return new PresetConfigMutator(config).disableMdxRs().toConfig();
48
- },
49
- markdown: {
50
- remarkPlugins: [remarkMermaid.remarkPlugin],
51
- globalComponents: remarkMermaid.mdxComponents,
52
- },
53
- builderConfig: remarkMermaid.builderConfig,
54
- };
55
- }
package/tsconfig.json DELETED
@@ -1,8 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "rootDir": "src",
4
- "outDir": "dist"
5
- },
6
- "include": ["src"],
7
- "extends": "../../tsconfig.base.json"
8
- }