gitbook 入门教程之超高颜值的思维导图simple-mind-map插件

  • 2020 年 3 月 17 日
  • 笔记

欢迎访问 gitbook-plugin-simple-mind-map 官网 ?

simple-mind-map-badge.png

在 markdown 中生成并导出思维导图的 Gitbook 插件

? 主页

屏幕截图

{% simplemindmap %}    ```markdown  - simplemindmap    - config book.json      - plugins        - others        - simple-mind-map      - pluginsConfig        - others        - simple-mind-map          - type          - preset          - linkShape          - autoFit          - style    - custom file.md      - markdown        - type        - preset        - linkShape        - autoFit        - style      - txtmap      - json      - mindmup  ```    {% endsimplemindmap %}

simple-mind-map-index-use-preview.png

用法

步骤＃1-更新 book.json 文件

在您的 gitbook 的 book.json 文件中,将 simple-mind-map 添加到 plugins 列表中.

这是最简单的示例：

{      "plugins": ["simple-mind-map"]  }

此外,受支持的配置选项如下:

"gitbook": {      "properties": {          "type": {              "type": "string",              "title": "Markdown or MindMup or Txtmap or Pandoc",              "required": false,              "default": "markdown"          },          "preset": {              "type": "string",              "title": "colorful or default",              "required": false,              "default": "colorful"          },          "linkShape": {              "type": "string",              "title": "diagonal or bracket",              "required": false,              "default": "diagonal"          },          "autoFit": {              "type": "boolean",              "title": "true or false",              "required": false,              "default": true          },          "style": {              "type": "object",              "title": "custom style",              "required": false          }      }  }

步骤＃2- 使用 markdown 语法

simplemindmap 插件支持 type,preset,linkShape,autoFit 和 style 等选项生成思维导图.

这是在 markdown 文件中基本使用语法:

{% simplemindmap %}  ```  simple mind map  ```  {% endsimplemindmap %}

下面有一些基本示例:

  • markdown

默认配置生成 markdown 版本的思维导图

{% simplemindmap %}    ```markdown  - simplemindmap    - config book.json      - plugins        - others        - simple-mind-map      - pluginsConfig        - others        - simple-mind-map          - type          - preset          - linkShape          - autoFit          - style    - custom file.md      - markdown        - type        - preset        - linkShape        - autoFit        - style      - txtmap      - json      - mindmup  ```    {% endsimplemindmap %}

simple-mind-map-examples-markdown-preview.png

  • txtmap

指定语言类型 type 生成 txtmap 版本的思维导图

{% simplemindmap type="txtmap" %}  ```txtmap  some    example      content    for    you      to      see        the      file        structure  ```  {% endsimplemindmap %}

simple-mind-map-examples-txtmap-preview.png

  • json

指定预设值 preset 和自定义样式 style 生成 json 版本的思维导图

{% simplemindmap type="json",preset="default",style={"height":"2000px"} %}  ```json  {   "name": "flare",   "children": [    {     "name": "analytics",     "children": [      {       "name": "cluster",       "children": [        {"name": "AgglomerativeCluster", "size": 3938},        {"name": "CommunityStructure", "size": 3812},        {"name": "HierarchicalCluster", "size": 6714},        {"name": "MergeEdge", "size": 743}       ]      },      {       "name": "graph",       "children": [        {"name": "BetweennessCentrality", "size": 3534},        {"name": "LinkDistance", "size": 5731},        {"name": "MaxFlowMinCut", "size": 7840},        {"name": "ShortestPaths", "size": 5914},        {"name": "SpanningTree", "size": 3416}       ]      },      {       "name": "optimization",       "children": [        {"name": "AspectRatioBanker", "size": 7074}       ]      }     ]    },    {     "name": "animate",     "children": [      {"name": "Easing", "size": 17010},      {"name": "FunctionSequence", "size": 5842},      {       "name": "interpolate",       "children": [        {"name": "ArrayInterpolator", "size": 1983},        {"name": "ColorInterpolator", "size": 2047},        {"name": "DateInterpolator", "size": 1375},        {"name": "Interpolator", "size": 8746},        {"name": "MatrixInterpolator", "size": 2202},        {"name": "NumberInterpolator", "size": 1382},        {"name": "ObjectInterpolator", "size": 1629},        {"name": "PointInterpolator", "size": 1675},        {"name": "RectangleInterpolator", "size": 2042}       ]      },      {"name": "ISchedulable", "size": 1041},      {"name": "Parallel", "size": 5176},      {"name": "Pause", "size": 449},      {"name": "Scheduler", "size": 5593},      {"name": "Sequence", "size": 5534},      {"name": "Transition", "size": 9201},      {"name": "Transitioner", "size": 19975},      {"name": "TransitionEvent", "size": 1116},      {"name": "Tween", "size": 6006}     ]    },    {     "name": "data",     "children": [      {       "name": "converters",       "children": [        {"name": "Converters", "size": 721},        {"name": "DelimitedTextConverter", "size": 4294},        {"name": "GraphMLConverter", "size": 9800},        {"name": "IDataConverter", "size": 1314},        {"name": "JSONConverter", "size": 2220}       ]      },      {"name": "DataField", "size": 1759},      {"name": "DataSchema", "size": 2165},      {"name": "DataSet", "size": 586},      {"name": "DataSource", "size": 3331},      {"name": "DataTable", "size": 772},      {"name": "DataUtil", "size": 3322}     ]    },    {     "name": "display",     "children": [      {"name": "DirtySprite", "size": 8833},      {"name": "LineSprite", "size": 1732},      {"name": "RectSprite", "size": 3623},      {"name": "TextSprite", "size": 10066}     ]    },    {     "name": "flex",     "children": [      {"name": "FlareVis", "size": 4116}     ]    },    {     "name": "physics",     "children": [      {"name": "DragForce", "size": 1082},      {"name": "GravityForce", "size": 1336},      {"name": "IForce", "size": 319},      {"name": "NBodyForce", "size": 10498},      {"name": "Particle", "size": 2822},      {"name": "Simulation", "size": 9983},      {"name": "Spring", "size": 2213},      {"name": "SpringForce", "size": 1681}     ]    },    {     "name": "query",     "children": [      {"name": "AggregateExpression", "size": 1616},      {"name": "And", "size": 1027},      {"name": "Arithmetic", "size": 3891},      {"name": "Average", "size": 891},      {"name": "BinaryExpression", "size": 2893},      {"name": "Comparison", "size": 5103},      {"name": "CompositeExpression", "size": 3677},      {"name": "Count", "size": 781},      {"name": "DateUtil", "size": 4141},      {"name": "Distinct", "size": 933},      {"name": "Expression", "size": 5130},      {"name": "ExpressionIterator", "size": 3617},      {"name": "Fn", "size": 3240},      {"name": "If", "size": 2732},      {"name": "IsA", "size": 2039},      {"name": "Literal", "size": 1214},      {"name": "Match", "size": 3748},      {"name": "Maximum", "size": 843},      {       "name": "methods",       "children": [        {"name": "add", "size": 593},        {"name": "and", "size": 330},        {"name": "average", "size": 287},        {"name": "count", "size": 277},        {"name": "distinct", "size": 292},        {"name": "div", "size": 595},        {"name": "eq", "size": 594},        {"name": "fn", "size": 460},        {"name": "gt", "size": 603},        {"name": "gte", "size": 625},        {"name": "iff", "size": 748},        {"name": "isa", "size": 461},        {"name": "lt", "size": 597},        {"name": "lte", "size": 619},        {"name": "max", "size": 283},        {"name": "min", "size": 283},        {"name": "mod", "size": 591},        {"name": "mul", "size": 603},        {"name": "neq", "size": 599},        {"name": "not", "size": 386},        {"name": "or", "size": 323},        {"name": "orderby", "size": 307},        {"name": "range", "size": 772},        {"name": "select", "size": 296},        {"name": "stddev", "size": 363},        {"name": "sub", "size": 600},        {"name": "sum", "size": 280},        {"name": "update", "size": 307},        {"name": "variance", "size": 335},        {"name": "where", "size": 299},        {"name": "xor", "size": 354},        {"name": "_", "size": 264}       ]      },      {"name": "Minimum", "size": 843},      {"name": "Not", "size": 1554},      {"name": "Or", "size": 970},      {"name": "Query", "size": 13896},      {"name": "Range", "size": 1594},      {"name": "StringUtil", "size": 4130},      {"name": "Sum", "size": 791},      {"name": "Variable", "size": 1124},      {"name": "Variance", "size": 1876},      {"name": "Xor", "size": 1101}     ]    },    {     "name": "scale",     "children": [      {"name": "IScaleMap", "size": 2105},      {"name": "LinearScale", "size": 1316},      {"name": "LogScale", "size": 3151},      {"name": "OrdinalScale", "size": 3770},      {"name": "QuantileScale", "size": 2435},      {"name": "QuantitativeScale", "size": 4839},      {"name": "RootScale", "size": 1756},      {"name": "Scale", "size": 4268},      {"name": "ScaleType", "size": 1821},      {"name": "TimeScale", "size": 5833}     ]    },    {     "name": "util",     "children": [      {"name": "Arrays", "size": 8258},      {"name": "Colors", "size": 10001},      {"name": "Dates", "size": 8217},      {"name": "Displays", "size": 12555},      {"name": "Filter", "size": 2324},      {"name": "Geometry", "size": 10993},      {       "name": "heap",       "children": [        {"name": "FibonacciHeap", "size": 9354},        {"name": "HeapNode", "size": 1233}       ]      },      {"name": "IEvaluable", "size": 335},      {"name": "IPredicate", "size": 383},      {"name": "IValueProxy", "size": 874},      {       "name": "math",       "children": [        {"name": "DenseMatrix", "size": 3165},        {"name": "IMatrix", "size": 2815},        {"name": "SparseMatrix", "size": 3366}       ]      },      {"name": "Maths", "size": 17705},      {"name": "Orientation", "size": 1486},      {       "name": "palette",       "children": [        {"name": "ColorPalette", "size": 6367},        {"name": "Palette", "size": 1229},        {"name": "ShapePalette", "size": 2059},        {"name": "SizePalette", "size": 2291}       ]      },      {"name": "Property", "size": 5559},      {"name": "Shapes", "size": 19118},      {"name": "Sort", "size": 6887},      {"name": "Stats", "size": 6557},      {"name": "Strings", "size": 22026}     ]    },    {     "name": "vis",     "children": [      {       "name": "axis",       "children": [        {"name": "Axes", "size": 1302},        {"name": "Axis", "size": 24593},        {"name": "AxisGridLine", "size": 652},        {"name": "AxisLabel", "size": 636},        {"name": "CartesianAxes", "size": 6703}       ]      },      {       "name": "controls",       "children": [        {"name": "AnchorControl", "size": 2138},        {"name": "ClickControl", "size": 3824},        {"name": "Control", "size": 1353},        {"name": "ControlList", "size": 4665},        {"name": "DragControl", "size": 2649},        {"name": "ExpandControl", "size": 2832},        {"name": "HoverControl", "size": 4896},        {"name": "IControl", "size": 763},        {"name": "PanZoomControl", "size": 5222},        {"name": "SelectionControl", "size": 7862},        {"name": "TooltipControl", "size": 8435}       ]      },      {       "name": "data",       "children": [        {"name": "Data", "size": 20544},        {"name": "DataList", "size": 19788},        {"name": "DataSprite", "size": 10349},        {"name": "EdgeSprite", "size": 3301},        {"name": "NodeSprite", "size": 19382},        {         "name": "render",         "children": [          {"name": "ArrowType", "size": 698},          {"name": "EdgeRenderer", "size": 5569},          {"name": "IRenderer", "size": 353},          {"name": "ShapeRenderer", "size": 2247}         ]        },        {"name": "ScaleBinding", "size": 11275},        {"name": "Tree", "size": 7147},        {"name": "TreeBuilder", "size": 9930}       ]      },      {       "name": "events",       "children": [        {"name": "DataEvent", "size": 2313},        {"name": "SelectionEvent", "size": 1880},        {"name": "TooltipEvent", "size": 1701},        {"name": "VisualizationEvent", "size": 1117}       ]      },      {       "name": "legend",       "children": [        {"name": "Legend", "size": 20859},        {"name": "LegendItem", "size": 4614},        {"name": "LegendRange", "size": 10530}       ]      },      {       "name": "operator",       "children": [        {         "name": "distortion",         "children": [          {"name": "BifocalDistortion", "size": 4461},          {"name": "Distortion", "size": 6314},          {"name": "FisheyeDistortion", "size": 3444}         ]        },        {         "name": "encoder",         "children": [          {"name": "ColorEncoder", "size": 3179},          {"name": "Encoder", "size": 4060},          {"name": "PropertyEncoder", "size": 4138},          {"name": "ShapeEncoder", "size": 1690},          {"name": "SizeEncoder", "size": 1830}         ]        },        {         "name": "filter",         "children": [          {"name": "FisheyeTreeFilter", "size": 5219},          {"name": "GraphDistanceFilter", "size": 3165},          {"name": "VisibilityFilter", "size": 3509}         ]        },        {"name": "IOperator", "size": 1286},        {         "name": "label",         "children": [          {"name": "Labeler", "size": 9956},          {"name": "RadialLabeler", "size": 3899},          {"name": "StackedAreaLabeler", "size": 3202}         ]        },        {         "name": "layout",         "children": [          {"name": "AxisLayout", "size": 6725},          {"name": "BundledEdgeRouter", "size": 3727},          {"name": "CircleLayout", "size": 9317},          {"name": "CirclePackingLayout", "size": 12003},          {"name": "DendrogramLayout", "size": 4853},          {"name": "ForceDirectedLayout", "size": 8411},          {"name": "IcicleTreeLayout", "size": 4864},          {"name": "IndentedTreeLayout", "size": 3174},          {"name": "Layout", "size": 7881},          {"name": "NodeLinkTreeLayout", "size": 12870},          {"name": "PieLayout", "size": 2728},          {"name": "RadialTreeLayout", "size": 12348},          {"name": "RandomLayout", "size": 870},          {"name": "StackedAreaLayout", "size": 9121},          {"name": "TreeMapLayout", "size": 9191}         ]        },        {"name": "Operator", "size": 2490},        {"name": "OperatorList", "size": 5248},        {"name": "OperatorSequence", "size": 4190},        {"name": "OperatorSwitch", "size": 2581},        {"name": "SortOperator", "size": 2023}       ]      },      {"name": "Visualization", "size": 16540}     ]    }   ]  }  ```  {% endsimplemindmap %}

simple-mind-map-examples-json-preview.png

  • mindmup

指定连接形状 linkShape 生成 mindmup 版本的思维导图

{% simplemindmap type="mindmup",preset="default",linkShape="bracket" %}  ```mindmup  {    "title": "MindMapping",    "id": 1,    "formatVersion": 2,    "ideas": {      "11": {        "title": "Software",        "id": 8,        "ideas": {          "1": {            "title": "FreeMind",            "id": 9          },          "2": {            "title": "XMind",            "id": 10          },          "3": {            "title": "MindMeister",            "id": 11          },          "4": {            "title": "iMindMap",            "id": 13,            "ideas": {              "1": {                "title": "by Tony Buzan",                "id": 30              }            }          },          "5": {            "title": "MindManager",            "id": 14          },          "2.5": {            "title": "MindMup",            "id": 12          }        }      },      "21": {        "title": "Misc",        "id": 15,        "ideas": {          "1": {            "title": "Visual Understanding Environment (VUE)",            "id": 23,            "ideas": {              "1": {                "title": "http://vue.tufts.edu/index.cfm",                "id": 24              }            }          },          "2": {            "title": "TiddlyMap",            "id": 26          },          "3": {            "title": "Orgmode.org",            "id": 27          },          "4": {            "title": "https://www.moh.io/mohiomap",            "id": 31,            "ideas": {}          }        }      },      "31": {        "title": "Resources",        "id": 2,        "ideas": {          "1": {            "title": "http://lifehacker.com/five-best-mind-mapping-tools-476534555",            "id": 18          },          "2": {            "title": "http://lifehacker.com/5188833/hive-five-five-best-mind-mapping-applications",            "id": 19          },          "3": {            "title": "https://en.wikipedia.org/wiki/List_of_concept-_and_mind-mapping_software",            "id": 21          }        },        "attr": {          "position": [            67.5,            255,            1          ],          "style": {}        }      }    }  }  ```  {% endsimplemindmap %}

simple-mind-map-examples-mindmup-preview.png

步骤＃3- 运行 gitbook 命令

  1. 运行 gitbook install .它将自动为您的 gitbook 安装 simple-mind-map 插件.

该步骤仅需要允许一次即可.

gitbook install

或者您可以运行 npm install gitbook-plugin-simple-mind-map 命令本地安装 gitbook-plugin-simple-mind-map 插件.

npm install gitbook-plugin-simple-mind-map
  1. 像往常一样构建您的书（ gitbook build ）或服务（ gitbook serve ）.
gitbook serve

示例

  • 官方文档配置文件

https://github.com/snowdreams1006/gitbook-plugin-simple-mind-map/blob/master/docs/book.json

{      "plugins": ["simple-mind-map"],      "pluginsConfig": {          "simple-mind-map": {              "type": "markdown",              "preset": "colorful",              "linkShape": "diagonal"          }      }  }
  • 官方示例配置文件

https://github.com/snowdreams1006/gitbook-plugin-simple-mind-map/blob/master/example/book.json

{      "plugins": ["simple-mind-map"],      "pluginsConfig": {          "simple-mind-map": {              "type": "markdown"          }      }  }
  • 示例 book.json 文件
{      "plugins": ["simple-mind-map"]  }

或者,您可以添加 preset or linkShape and autoFit 作为默认设置选项:

{      "plugins": ["simple-mind-map"],      "pluginsConfig": {          "simple-mind-map": {              "type": "markdown",              "preset": "colorful",              "linkShape": "diagonal",              "autoFit": true          }      }  }

或者您可以添加 style 以自定义思维导图样式：

{      "plugins": ["simple-mind-map"],      "pluginsConfig": {          "simple-mind-map": {              "type": "markdown",              "preset": "colorful",              "linkShape": "diagonal",              "autoFit": true,              "style": {                "height":  "750px"              }          }      }  }

注意 ：如果您的书还没有创建,以上代码段可以用作完整的 book.json 文件.

作者

? snowdreams1006

贡献

欢迎提供文稿，问题和功能请求！
随时检查问题页面 。

表示支持

如果这个项目对您有帮助，请给个星星 ！

版权

版权所有 ©2019 snowdreams1006 。

该项目是MIT许可的。

如果本文对你有所帮助,请动动小手点一下推荐,否则还请留言指正,如有需要,请关注个人公众号“ 雪之梦技术驿站 ”

雪之梦技术驿站.png

VirMach 便宜 VPS

QNews

QNews