Skip to content

Markmap 示例

代码块形式

基础用法

使用 markmap 代码块形式,插入 Markdown 文件内容:

自定义配置示例

基础配置

高级配置

暗黑模式适配

组件形式

基础用法

使用组件形式,指定 Markdown 文件路径,读取 Markdown 文件内容:

showToolbar 为可选参数,默认不显示工具栏,添加 showToolbar 参数则显示工具栏

vue
<!-- 指定路径,读取指定文件(支持相对路径、绝对路径) -->
<PreviewMarkmapPath path="./Vue.md" />
vue
<!-- 不指定路径,则读取当前文件 -->
<PreviewMarkmapPath showToolbar />

带配置的组件用法

你也可以在引用的 Markdown 文件中添加配置:

markdown
## <!-- 在引用的文件中添加配置 -->

showToolbar: true
markmap:
color: ["#e74c3c", "#3498db", "#2ecc71", "#f1c40f", "#9b59b6"]
initialExpandLevel: 2
maxWidth: 450
duration: 350

---

# 组件测试

## 前端框架

### React

#### Hooks

#### Context

### Vue

#### Composition API

#### Options API

## 构建工具

### Webpack

### Vite

### Rollup

## 数据库

### SQL

#### PostgreSQL

#### MySQL

### NoSQL

#### MongoDB

#### Redis

配置选项详解

基础选项

选项类型默认值说明
showToolbarbooleantrue是否显示工具栏
colorstring[]d3.schemeCategory10节点颜色数组
initialExpandLevelnumber-1初始展开层级,-1 表示全部展开
maxWidthnumber0节点最大宽度,0 表示无限制
durationnumber500动画持续时间(毫秒)

布局选项

选项类型默认值说明
spacingHorizontalnumber80水平间距
spacingVerticalnumber5垂直间距
paddingXnumber2X轴内边距

交互选项

选项类型默认值说明
zoombooleantrue是否允许缩放
panbooleantrue是否允许平移
autoFitbooleanfalse是否自动适应容器
fitRationumber1适应比例

高级选项

选项类型默认值说明
colorFreezeLevelnumber0颜色冻结层级
toggleRecursivelybooleanfalse是否递归切换
scrollForPanbooleanfalse是否滚动平移
maxInitialScalenumber1最大初始缩放比例
lineWidthnumber1节点间连线的宽度

使用技巧

  1. 颜色配置: 颜色数组会循环使用,如果节点数量超过颜色数量
  2. 展开层级: initialExpandLevel: -1 表示全部展开,0 表示只展开根节点
  3. 性能优化: 过多的节点或复杂的配置可能影响渲染性能
  4. 响应式设计: 思维导图会自动适应容器大小
  5. 主题适配: 支持 VitePress 的明暗主题切换

更多配置选项请参考 Markmap 官方文档