-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6209ed0
commit 1b9f741
Showing
60 changed files
with
6,900 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# markdown-chart | ||
|
||
<NpmBadge package="@vuepress/plugin-markdown-chart" /> | ||
|
||
Add powerful charts to your VuePress site. | ||
|
||
This plugin provides 6 ways to let you insert charts into your markdown file. | ||
|
||
- chart.js: A lightweight, easy-to-use, highly customizable chart library. | ||
|
||
chart.js is lighter comparing to echarts. | ||
|
||
- echarts: A powerful, interactive charting and visualization library for browser. | ||
|
||
echarts is more powerful comparing to chart.js. | ||
|
||
- Flowchart: A simple markdown extension to generate flowcharts and sequence diagrams. | ||
|
||
Lightweight, only focusing on flowcharts. | ||
|
||
- Markmap: Create mindmap with markdown | ||
|
||
The runtime is very heavy, not recommended. | ||
|
||
- Mermaid: Generation of diagram and flowchart from text in a similar manner as markdown. | ||
|
||
Powerful collection of common charts. | ||
|
||
- Plantuml: UML diagram driven by Java. | ||
|
||
No runtime, diagram render is processed on plantuml server. | ||
|
||
## Usage | ||
|
||
```bash | ||
npm i -D @vuepress/plugin-markdown-chart@next | ||
``` | ||
|
||
```ts | ||
import { markdownChartPlugin } from '@vuepress/plugin-markdown-chart' | ||
|
||
export default { | ||
plugins: [ | ||
markdownChartPlugin({ | ||
// Enable chart.js | ||
chartjs: true, | ||
// Enable echarts | ||
echarts: true, | ||
// Enable flowchart.ts | ||
flowchart: true, | ||
// Enable markmap | ||
markmap: true, | ||
// Enable mermaid | ||
mermaid: true, | ||
}), | ||
], | ||
} | ||
``` |
Oops, something went wrong.