diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
index 2153e11be..cdd6167b7 100644
--- a/.github/workflows/publish-docs.yml
+++ b/.github/workflows/publish-docs.yml
@@ -5,6 +5,7 @@ on:
push:
branches:
- master
+ pull_request:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
@@ -52,6 +53,7 @@ jobs:
# Deployment job
deploy:
+ if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
environment:
name: github-pages
runs-on: ubuntu-latest
diff --git a/.github/workflows/release-publish.yml b/.github/workflows/release-publish.yml
index 6f0806de1..28094453e 100644
--- a/.github/workflows/release-publish.yml
+++ b/.github/workflows/release-publish.yml
@@ -11,18 +11,21 @@ jobs:
- uses: actions/checkout@v3
- uses: fregante/setup-git-user@v1
- - name: Setup Node.js
+ - uses: pnpm/action-setup@v2
+ # uses version from "packageManager" field in package.json
+
+ - name: Setup Node.js v18
uses: actions/setup-node@v3
with:
+ cache: pnpm
node-version: 18.x
- - name: Install Yarn
- run: npm i yarn --global
-
- - name: Install Json
- run: npm i json --global
- name: Install Packages
- run: yarn install --frozen-lockfile
+ run: |
+ pnpm install --frozen-lockfile
+ npm i json --global
+ env:
+ CYPRESS_CACHE_FOLDER: .cache/Cypress
- name: Prepare release
run: |
@@ -31,7 +34,7 @@ jobs:
git checkout -t origin/release/$VERSION
npm version --no-git-tag-version --allow-same-version $VERSION
git add package.json
- git commit -m "Bump version $VERSION"
+ git commit -nm "Bump version $VERSION"
git checkout -t origin/master
git merge -m "Release $VERSION" --no-ff release/$VERSION
git push --no-verify
diff --git a/.vite/build.ts b/.vite/build.ts
index 019461c49..e3c947173 100644
--- a/.vite/build.ts
+++ b/.vite/build.ts
@@ -20,13 +20,14 @@ const visualizerOptions = (packageName: string, core = false): PluginOption[] =>
if (packageName !== 'mermaid' || !visualize) {
return [];
}
- return ['network', 'treemap', 'sunburst'].map((chartType) =>
- visualizer({
- filename: `./stats/${chartType}${core ? '.core' : ''}.html`,
- template: chartType as TemplateType,
- gzipSize: true,
- brotliSize: true,
- })
+ return ['network', 'treemap', 'sunburst'].map(
+ (chartType) =>
+ visualizer({
+ filename: `./stats/${chartType}${core ? '.core' : ''}.html`,
+ template: chartType as TemplateType,
+ gzipSize: true,
+ brotliSize: true,
+ }) as PluginOption
);
};
@@ -36,9 +37,9 @@ const packageOptions = {
packageName: 'mermaid',
file: 'mermaid.ts',
},
- 'mermaid-mindmap': {
- name: 'mermaid-mindmap',
- packageName: 'mermaid-mindmap',
+ 'mermaid-example-diagram': {
+ name: 'mermaid-example-diagram',
+ packageName: 'mermaid-example-diagram',
file: 'detector.ts',
},
};
@@ -114,7 +115,7 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
if (watch && config.build) {
config.build.watch = {
- include: ['packages/mermaid-mindmap/src/**', 'packages/mermaid/src/**'],
+ include: ['packages/mermaid-example-diagram/src/**', 'packages/mermaid/src/**'],
};
}
@@ -122,11 +123,9 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
};
const buildPackage = async (entryName: keyof typeof packageOptions) => {
- return Promise.allSettled([
- build(getBuildConfig({ minify: false, entryName })),
- build(getBuildConfig({ minify: 'esbuild', entryName })),
- build(getBuildConfig({ minify: false, core: true, entryName })),
- ]);
+ await build(getBuildConfig({ minify: false, entryName }));
+ await build(getBuildConfig({ minify: 'esbuild', entryName }));
+ await build(getBuildConfig({ minify: false, core: true, entryName }));
};
const main = async () => {
@@ -139,7 +138,7 @@ const main = async () => {
if (watch) {
build(getBuildConfig({ minify: false, watch, core: false, entryName: 'mermaid' }));
if (!mermaidOnly) {
- build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-mindmap' }));
+ build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-example-diagram' }));
}
} else if (visualize) {
await build(getBuildConfig({ minify: false, core: true, entryName: 'mermaid' }));
diff --git a/.vite/server.ts b/.vite/server.ts
index aced396ec..0f1fef91d 100644
--- a/.vite/server.ts
+++ b/.vite/server.ts
@@ -22,7 +22,7 @@ async function createServer() {
app.use(cors);
app.use(express.static('./packages/mermaid/dist'));
// app.use(express.static('./packages/mermaid-example-diagram/dist'));
- app.use(express.static('./packages/mermaid-mindmap/dist'));
+ app.use(express.static('./packages/mermaid-example-diagram/dist'));
app.use(vite.middlewares);
app.use(express.static('demos'));
app.use(express.static('cypress/platform'));
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cf199c39b..b0320b36e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -63,6 +63,28 @@ flowchart LR
```
+You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box.
+Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
+
+````
+```note
+Note content
+```
+
+```tip
+Tip content
+```
+
+```warning
+Warning content
+```
+
+```danger
+Danger content
+```
+
+````
+
**_DO NOT CHANGE FILES IN `/docs`_**
### The official documentation site
diff --git a/cypress/integration/other/external-diagrams.spec.js b/cypress/integration/other/external-diagrams.spec.js
index be69dfc98..c94235162 100644
--- a/cypress/integration/other/external-diagrams.spec.js
+++ b/cypress/integration/other/external-diagrams.spec.js
@@ -2,8 +2,8 @@ import { urlSnapshotTest } from '../../helpers/util';
describe('mermaid', () => {
describe('registerDiagram', () => {
- it('should work on @mermaid-js/mermaid-mindmap and mermaid-example-diagram', () => {
- const url = 'http://localhost:9000/external-diagrams-mindmap.html';
+ it('should work on @mermaid-js/mermaid-example-diagram', () => {
+ const url = 'http://localhost:9000/external-diagrams-example-diagram.html';
urlSnapshotTest(url, {}, false, false);
});
});
diff --git a/cypress/platform/external-diagrams-mindmap.html b/cypress/platform/external-diagrams-example-diagram.html
similarity index 60%
rename from cypress/platform/external-diagrams-mindmap.html
rename to cypress/platform/external-diagrams-example-diagram.html
index e445a7627..9d2cad778 100644
--- a/cypress/platform/external-diagrams-mindmap.html
+++ b/cypress/platform/external-diagrams-example-diagram.html
@@ -2,34 +2,8 @@
Should correctly load a third-party diagram using registerDiagram
-mindmap
- root
- A
- B
- C
- D
- E
- A2
- B2
- C2
- D2
- E2
- child1((Circle))
- grandchild 1
- grandchild 2
- child2(Round rectangle)
- grandchild 3
- grandchild 4
- child3[Square]
- grandchild 5
- ::icon(mdi mdi-fire)
- gc6((grand
child 6))
- ::icon(mdi mdi-fire)
- gc7((grand
grand
child 8))
+example-diagram
-
@@ -37,11 +11,11 @@ mindmap