Skip to content

Commit 2edb39a

Browse files
hojashojas
committed
init
1 parent 1073457 commit 2edb39a

File tree

13 files changed

+1596
-0
lines changed

13 files changed

+1596
-0
lines changed

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
18

‎.prettierrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"semi": false,
3+
"singleQuote": true
4+
}

‎README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# vue-mermaid-render
2+
3+
Vue component to render diagrams with Mermaid.
4+
5+
## Install
6+
7+
```shell
8+
$ npm install vue-mermaid-render
9+
```
10+
11+
## Use
12+
13+
```vue
14+
15+
<script setup lang="ts">
16+
import { VueMermaidRender } from 'vue-mermaid-render'
17+
18+
const content = `
19+
graph TD;
20+
A-->B;
21+
A-->C;
22+
B-->D;
23+
C-->D;
24+
`
25+
</script>
26+
27+
<template>
28+
<VueMermaidRender :content="content" />
29+
</template>
30+
```
31+
32+
## Props
33+
34+
- `content`: `string` diagram content string
35+
- `config`: `MermaidConfig` mermaid config
36+
37+
## Related
38+
39+
[mermaid](https://github.com/mermaid-js/mermaid)

‎index.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>vue-mermaid-render</title>
7+
</head>
8+
<body>
9+
<div id="app"></div>
10+
<script type="module" src="/src/index.ts"></script>
11+
</body>
12+
</html>

‎package.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"name": "vue-mermaid-render",
3+
"version": "0.0.1",
4+
"packageManager": "pnpm@7.27.0",
5+
"type": "module",
6+
"files": [
7+
"dist"
8+
],
9+
"types": "./dist/index.d.ts",
10+
"main": "./dist/vue-mermaid-render.umd.cjs",
11+
"module": "./dist/vue-mermaid-render.js",
12+
"exports": {
13+
".": {
14+
"import": "./dist/vue-mermaid-render.js",
15+
"require": "./dist/vue-mermaid-render.umd.cjs"
16+
}
17+
},
18+
"scripts": {
19+
"build": "vite build && vue-tsc --declaration --emitDeclarationOnly"
20+
},
21+
"dependencies": {
22+
"mermaid": "^9.3.0",
23+
"vue": "^3.2.47"
24+
},
25+
"devDependencies": {
26+
"@types/node": "^18.13.0",
27+
"@vitejs/plugin-vue": "^4.0.0",
28+
"prettier": "^2.8.4",
29+
"typescript": "^4.9.5",
30+
"vite": "^4.1.1",
31+
"vite-plugin-dts": "^1.7.2",
32+
"vue-tsc": "^1.0.24"
33+
}
34+
}

0 commit comments

Comments
 (0)