-
Notifications
You must be signed in to change notification settings - Fork 80
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
Showing
22 changed files
with
759 additions
and
91 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
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
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,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2021 Xiaohan Zou (@Renovamen) | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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,56 @@ | ||
| # vuepress-plugin-markmap | ||
|
|
||
| A plugin for adding [markmap](https://github.com/gera2ld/markmap) to [VuePress](https://vuepress.vuejs.org/) to visualize your Markdown as mindmaps. | ||
|
|
||
| | ||
|
|
||
| ## Installation | ||
|
|
||
| Install this plugin with: | ||
|
|
||
| ```bash | ||
| yarn add vuepress-plugin-markmap | ||
| # or | ||
| npm install vuepress-plugin-markmap | ||
| ``` | ||
|
|
||
| And add it to your `.vuepress/config.js`: | ||
|
|
||
| ```js | ||
| module.exports = { | ||
| plugins: [ | ||
| [ | ||
| 'vuepress-plugin-markmap' | ||
| ] | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| | ||
|
|
||
| ## Usage | ||
|
|
||
| Then you can use [markmap](https://github.com/gera2ld/markmap) in Markdown: | ||
|
|
||
| ~~~markdown | ||
| ```markmap | ||
| # Fruit | ||
|
|
||
| ## Red | ||
|
|
||
| - [Apple](https://en.wikipedia.org/wiki/Apple) | ||
| - *Cherry* | ||
|
|
||
| ## Yellow | ||
|
|
||
| - **Lemon** | ||
| - Banana | ||
| - ~~Pumpkin~~ | ||
| ``` | ||
| ~~~ | ||
|
|
||
| | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](LICENSE) |
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,6 @@ | ||
| import Markmap from "./lib/Markmap"; | ||
|
|
||
| export default function (ctx) { | ||
| const { Vue } = ctx; | ||
| Vue.component("Markmap", Markmap); | ||
| } |
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,12 @@ | ||
| const path = require("path"); | ||
| const markmap = require("./lib/markdown-it-markmap"); | ||
|
|
||
| module.exports = (options, ctx) => { | ||
| return { | ||
| name: "vuepress-plugin-markmap", | ||
| enhanceAppFiles: path.resolve(__dirname, "./enhanceApp.js"), | ||
| chainMarkdown(config) { | ||
| config.plugin("markmap").use(markmap); | ||
| } | ||
| }; | ||
| }; |
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,55 @@ | ||
| <template> | ||
| <div class="vuepress-markmap"> | ||
| <svg :id="id" ref="markmap"></svg> | ||
| </div> | ||
| </template> | ||
|
|
||
| <script> | ||
| import { transform, getUsedAssets } from "markmap-lib/dist/transform"; | ||
| import { Markmap, loadCSS, loadJS } from "markmap-lib/dist/view"; | ||
| import * as markmap from "markmap-lib/dist/view"; | ||
| export default { | ||
| name: "Markmap", | ||
| props: { | ||
| id: { | ||
| type: String, | ||
| required: true | ||
| }, | ||
| code: { | ||
| type: String, | ||
| required: true | ||
| } | ||
| }, | ||
| mounted() { | ||
| // transform markdown | ||
| const { root, features } = transform(this.code); | ||
| // get assets required by used features | ||
| const { styles, scripts } = getUsedAssets(features); | ||
| // load assets | ||
| if (styles) loadCSS(styles); | ||
| if (scripts) loadJS(scripts, { getMarkmap: () => markmap }); | ||
| // create markmap | ||
| const svg = this.$refs.markmap; | ||
| const mm = Markmap.create(svg, null, root); | ||
| // resize svg and fit graph | ||
| // https://github.com/gera2ld/markmap/issues/63 | ||
| mm.rescale(1).then(function () { | ||
| svg.style.height = svg.getBBox().height + 10 + "px"; | ||
| mm.fit(); | ||
| }); | ||
| } | ||
| }; | ||
| </script> | ||
|
|
||
| <style lang="stylus"> | ||
| .vuepress-markmap | ||
| margin 30px 0 | ||
| width 100% | ||
| svg | ||
| display block | ||
| width 100% | ||
| </style> |
Oops, something went wrong.
1e942dcThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: