vue markdown 生成--自动生成markdown文档侧边栏目录

时间: 2023-07-04 18:08:56 浏览: 149
在 Vue 中使用 Markdown 生成文档时,可以通过以下步骤自动生成侧边栏目录: 1. 在项目中安装 `markdown-it` 和 `markdown-it-anchor` 库: ```bash npm install markdown-it markdown-it-anchor --save ``` 2. 在 Vue 组件中引入并初始化 `markdown-it` 和 `markdown-it-anchor`: ```javascript import MarkdownIt from 'markdown-it' import MarkdownItAnchor from 'markdown-it-anchor' const md = new MarkdownIt({ html: true, linkify: true, typographer: true, }) md.use(MarkdownItAnchor) ``` 3. 在 Vue 组件中使用 `v-html` 指令渲染 Markdown 文本,并使用 `@hook:mounted` 钩子函数监听渲染完成事件,在事件处理函数中获取文档中所有标题标签(如 `h1`、`h2` 等),并根据标题级别生成目录树: ```html <template> <div> <div v-html="html"></div> <div class="sidebar"> <ul> <li v-for="item in toc" :key="item.id"> <a :href="'#' + item.id">{{ item.text }}</a> <ul v-if="item.children"> <li v-for="child in item.children" :key="child.id"> <a :href="'#' + child.id">{{ child.text }}</a> </li> </ul> </li> </ul> </div> </div> </template> <script> export default { data() { return { html: '', toc: [], } }, mounted() { this.html = md.render('# Hello World\n## Introduction\n### Features\n### Installation\n## Usage\n## API Reference') this.$nextTick(() => { const headers = Array.from(document.querySelectorAll('h1, h2, h3, h4, h5, h6')) this.toc = headers.map(header => ({ id: header.id, text: header.textContent, level: Number(header.tagName[1]), })).reduce((acc, header) => { let lastItem = acc[acc.length - 1] if (!lastItem || header.level <= lastItem.level) { acc.push(header) } else { let parent = lastItem while (parent.children && header.level > parent.level) { parent = parent.children[parent.children.length - 1] } if (!parent.children) { parent.children = [] } parent.children.push(header) } return acc }, []) }) }, } </script> ``` 4. 在 Vue 组件的样式中定义侧边栏样式: ```css .sidebar { position: fixed; top: 0; right: 0; bottom: 0; width: 200px; padding: 20px; overflow-y: auto; } ``` 这样就可以在 Vue Markdown 文档中自动生成侧边栏目录了。当然,这只是一个简单的示例,实际项目中可能需要根据具体需求进行一些定制化调整。

相关推荐

最新推荐

recommend-type

详解使用vue-admin-template的优化历程

主要介绍了详解使用vue-admin-template的优化历程,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
recommend-type

vue-simple-uploader上传成功之后的response获取代码

主要介绍了vue-simple-uploader上传成功之后的response获取代码,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧~
recommend-type

使用form-create动态生成vue自定义组件和嵌套表单组件

主要介绍了使用form-create动态生成vue自定义组件和嵌套表单组件,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
recommend-type

vue-video-player 通过自定义按钮组件实现全屏切换效果【推荐】

主要介绍了vue-video-player,通过自定义按钮组件实现全屏切换效果,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
recommend-type

Vue动态生成el-checkbox点击无法赋值的解决方法

最近遇到一个问题,在一个页面需要动态渲染页面内的表单,其中包括 checkbox 表单类型,并且使用 Element 组件 UI 时,此时 v-model 绑定的数据也是动态生成的 例如: 定义的 data 的 form 里面是空对象,需要动态...
recommend-type

zigbee-cluster-library-specification

最新的zigbee-cluster-library-specification说明文档。
recommend-type

管理建模和仿真的文件

管理Boualem Benatallah引用此版本:布阿利姆·贝纳塔拉。管理建模和仿真。约瑟夫-傅立叶大学-格勒诺布尔第一大学,1996年。法语。NNT:电话:00345357HAL ID:电话:00345357https://theses.hal.science/tel-003453572008年12月9日提交HAL是一个多学科的开放存取档案馆,用于存放和传播科学研究论文,无论它们是否被公开。论文可以来自法国或国外的教学和研究机构,也可以来自公共或私人研究中心。L’archive ouverte pluridisciplinaire
recommend-type

实现实时数据湖架构:Kafka与Hive集成

![实现实时数据湖架构:Kafka与Hive集成](https://img-blog.csdnimg.cn/img_convert/10eb2e6972b3b6086286fc64c0b3ee41.jpeg) # 1. 实时数据湖架构概述** 实时数据湖是一种现代数据管理架构,它允许企业以低延迟的方式收集、存储和处理大量数据。与传统数据仓库不同,实时数据湖不依赖于预先定义的模式,而是采用灵活的架构,可以处理各种数据类型和格式。这种架构为企业提供了以下优势: - **实时洞察:**实时数据湖允许企业访问最新的数据,从而做出更明智的决策。 - **数据民主化:**实时数据湖使各种利益相关者都可
recommend-type

可见光定位LED及其供电硬件具体型号,广角镜头和探测器,实验设计具体流程步骤,

1. 可见光定位LED型号:一般可使用5mm或3mm的普通白色LED,也可以选择专门用于定位的LED,例如OSRAM公司的SFH 4715AS或Vishay公司的VLMU3500-385-120。 2. 供电硬件型号:可以使用常见的直流电源供电,也可以选择专门的LED驱动器,例如Meanwell公司的ELG-75-C或ELG-150-C系列。 3. 广角镜头和探测器型号:一般可采用广角透镜和CMOS摄像头或光电二极管探测器,例如Omron公司的B5W-LA或Murata公司的IRS-B210ST01。 4. 实验设计流程步骤: 1)确定实验目的和研究对象,例如车辆或机器人的定位和导航。
recommend-type

JSBSim Reference Manual

JSBSim参考手册,其中包含JSBSim简介,JSBSim配置文件xml的编写语法,编程手册以及一些应用实例等。其中有部分内容还没有写完,估计有生之年很难看到完整版了,但是内容还是很有参考价值的。