为 github markdown 文件生成目录

Mr_houzi 发布于2019-08-16 12:43 / 2377人阅读

摘要：文件一键生成目录支持优雅的写法支持多次生成支持重复标题的生成支持特殊字符的过滤支持指定不同的文件编码支持文件夹的文件批量处理可指定是否包含子文件夹文件支持是否写入文件，可返回目录的内容，便于用户自行处理环境依赖请确保设置正确。

业务需要

在编写 github 项目时，有时候会编写各种 README.md 等 markdown 文件，但是 github 默认是没有目录的。

于是就自己想办法写了一个小工具。

markdown-toc

markdown-toc 可以用来生成 markdown 页面的目录，便于 github 页面展现。

Features

Github Markdown 文件一键生成目录

支持 fluent 优雅的写法

支持多次生成

支持重复标题的生成

支持特殊字符的过滤

支持指定不同的文件编码

支持文件夹的文件批量处理(可指定是否包含子文件夹文件)

支持是否写入文件，可返回目录的内容，便于用户自行处理

...

环境依赖 JDK

JDK7+, 请确保 JDK 设置正确。

Maven

Jar 使用 Maven 进行统一管理。

快速入门 maven 引入


    com.github.houbb
    markdown-toc
    1.0.2

md 文件

本项目支持的 md 文件后缀名称为 .md 或者 .markdown

快速开始

单个文件

AtxMarkdownToc.newInstance().genTocFile(path);

其中 path 为 md 文件的路径

指定文件夹

AtxMarkdownToc.newInstance().genTocFile(path);

其中 path 为 md 文件的父类文件夹

属性配置

代码示例

AtxMarkdownToc.newInstance()
                .charset("UTF-8")
                .write(true)
                .subTree(true);

属性说明

序号	属性	默认值	说明
1	charset	UTF-8	文件编码
2	write	true	是否将 toc 写入文件(默认写入)
3	subTree	true	是否包含子文件夹的文件(默认包含)

返回值说明

genTocFile() 返回 TocGen，genTocDir() 返回 List

TocGen 属性说明

序号	属性	类型	说明
1	filePath	String	当前 md 的文件路径
2	tocLines	List	当前 md 文件对应的目录内容

测试案例

单个文件-目录生成测试案例

文件夹-目录生成测试案例

github 地址

markdown-toc

云服务器 GPU云服务器 php生成为txt文件 php生成目录树 java的目录生成 js递归生成目录树

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/71584.html

Markdown 的文章目录在 Vim 里的终极解决方案

摘要：目前支持的解析引擎更新已经存在的文章目录。生成链接风格的文章目录。默认值用于控制保存文件时是否自动更新已有文章目录。我使用的与相关的插件解决文章目录的问题。如果你使用 Vim 编辑 Markdown，而且也为如何生成和更新文章目录（Table of Contents）而烦恼，那么如下的内容将带你脱离刀耕火种手写 Toc 的体验，回归使用 Markdown 是为了专注于内容的初心。一...

cpupro 2019-06-28 10:18 评论0 收藏0
使用 Hexo 创建项目文档网站

摘要：而且通常来说，是用来介绍项目，而不是展示文档。如果不确定系统中是否已经安装了，使用下面的命令检查如果出现了的版本号，则不需要再安装了。例如我执行的命令如下然后使用进入项目目录，并创建一个名为的目录目录将存放我们的文档。当我们发布一个开源项目的时候，最重要的事情之一就是要创建项目文档。对使用项目的用户来说，文档是非常有必要的，通常我们可以使用下面这些方式来创建文档： GitHub W...

mikasa 2019-08-01 17:05 评论0 收藏0
搭建博客太简单，这次我们来做一个博客生成工具

摘要：代码如下首页的模版博客网站的基本配置菜单生成，这里不讲讲中的遍历，然后生成一个数组默认按发布时间排序置顶替换五集成在编译博客的过程中，一些操作利用会简单快捷许多。文章较长，耐心读下来我想你肯定会有所收获 : ) 作为一个技术人员，见到别人那光鲜亮丽的个人博客，心里总免不了想搭建自己博客的冲动。当然，搭建博客的方式有好多种，但是大体上分这两种：服务端数据库例如：你可以用 Word...

chanthuang 2019-08-23 11:55 评论0 收藏0
文档生成工具 idoc

摘要：文档生成工具简介通过生成静态页面的工具。通过生成静态页面的工具本地存储操作本地操作浏览器各种方法通知常用命令测试工具快捷键源码仓库仓库地址欢迎提需求和，提交地址。运行预览生成的静态页面。监控文件发生变化自动。 AIP文档生成工具 ,, ,, db `7MM MM `7MM ,MbMM ,pWWq. ,p6...

ASCH 2019-08-21 10:42 评论0 收藏0