GitHub上生成Markdown [TOC] 样式的目录 --- DOM方式实现

最新推荐文章于 2024-06-26 10:04:09 发布

原创最新推荐文章于 2024-06-26 10:04:09 发布 · 1.2k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#markdown toc #markdown #github

Markdown 同时被 2 个专栏收录

2 篇文章

订阅专栏

GitHub

2 篇文章

订阅专栏

本文介绍了一种在GitHub上利用Markdown格式自动生成目录的方法，通过特定的Java工具，可以快速为Markdown文档创建清晰的目录结构，提升阅读体验。

GitHub支持 Markdown TOC目录生成

参考项目:

https://github.com/YuraAAA/Markdown-Toc-Generator/

https://github.com/zhang0peter/markdown2html

项目地址

https://github.com/javakam/markdown-toc-dom

效果图

效果图.png

使用方式

1.下载 github-markdown-toc.jar ;

2.安装 Java 运行环境;

3.双击运行

4.输入Markdown格式文本:

 [toc]
# Heading **some bold** 
## Heading 1.1 _some italic
### Heading 1.1.1
### Heading 1.1.2  **_some bold italic_**
#### Heading 1.1.2.1  **_some bold italic_666**
##### Heading 1.1.2.1.1  **_some bold 2222**

上面代码生成效果:

本资源提供了一个简单方法，用于生成华丽的markdown文档侧边栏目录。本资源包含一个模板文档，没有任何程序代码，简单易用。本模板是对开源项目 i5ting-i5ting_ztree_toc-0.3.0-11 的精简，主要是针对Windows下无法安装项目作者给出的软件（仅适用于Linux）的问题进行一定的优化。经过精简之后，使用方法非常简单，仅仅是一次复制&一次粘贴。

参与评论您还未登录，请先登录后发表或查看评论

为 github markdown 文件生成目录(toc)

热门推荐

01-30

6万+

缘起有需求，才有创作。每次写 github 上的 README.md，内容较多时阅读不方便，也没有自动生成的 TOC(目录)。于是就自己写了一个。 markdown-toc markdown-toc 可以根据 atx(# 指定标题) 标题形式的 markdown 文件生成对应目录。效果展示 Before After

github生成markdown文件目录

华小少

09-09

335

参考 VSCode中的Markdown All in One 插件。安装后点开md文件，然后快捷键CTRL(CMD)+SHIFT+P，输入Markdown All in One: Create Table of Contents回车即可。

markdown 生成目录_为 github markdown 文件生成目录(toc)

weixin_39629129的博客

11-28

607

业务需要在编写 github 项目时，有时候会编写各种 README.md 等 markdown 文件，但是 github 默认是没有目录的。于是就自己写了一个小工具。markdown-tocmarkdown-toc 可以用来生成 markdown 页面的目录，便于 github 页面展现。FeaturesGithub Markdown 文件一键生成目录支持 fluent 优雅的写法支持多次生成支...

github-markdown-toc-chrome-extension:自动生成github markdown的toc

06-15

github-markdown-toc-chrome-extension 是一个谷歌浏览器扩展，用于自动为 GitHub Markdown 生成目录。安装您可以通过安装。执照该程序由 Apache 许可证 2.0 授权。请参阅名为 LICENSE 的文件。致谢 github-...

GitHub Markdown文章目录生成工具Chrome扩展

其核心功能是自动解析GitHub上的Markdown格式文章，并在页面侧边生成一个清晰、可交互的文章标题目录（Table of Contents，简称TOC），从而实现高效的内容导航。该工具特别适用于浏览技术文档、开源项目说明（如...

doctoc-web：为Markdown文件生成目录的Web工具

“doctoc-web”是一个基于Web的前端工具，旨在为Markdown格式的文档自动生成目录（Table of Contents, 简称ToC），其核心功能是提升技术文档、项目说明文件或开源项目的可读性与导航效率。该项目作为“doctoc”...

Chrome扩展:GitHub Markdown自动生成目录工具

从技术角度讲，GitHub-Markdown-TOC-crx插件的实现依赖于Chrome扩展程序API，它能够访问和解析Markdown文档的DOM结构，以便找到所有的标题标签并构建目录。同时，插件还支持Markdown文档的一些特殊语法，比如任务...

simpletoc：轻量级DOM和Markdown目录生成工具

然后通过编写简单的脚本，调用simpletoc函数并传入配置对象，即可在页面上生成目录。这种目录生成器特别适合于博客文章、文档、教程等长篇内容的网站，能够极大地方便用户浏览和定位感兴趣的内容部分。例如，如果...

remark-extract-toc:用于存储目录的备注插件

05-29

备注提取目录插件来存储目录。该插件仅从 markdown 中提取Heading ，然后将它们转换为保持深度的嵌套对象树。安装 npm install remark-extract-toc 用法 var unified = require ( "unified" ) ; var markdown = require ( "remark-parse" ) ; var extractToc = require ( "remark-extract-toc" ) ; var fs = require ( "fs" ) ; var text = fs . readFileSync ( "example.md" , "utf8" ) ; var processor = unified ( ) . use ( markdown ) . use ( extractToc ) ; var nod

githubMarkDown目录/页内跳转

weixin_43938560的博客

07-25

948

github通过锚点来实现页内跳转，每一个标题就是一个锚点正确的连接方式：对于标题 #Hello World 使用 [Hello World](#hello-world) 连接注意：()中的字母全部小写，并且单词之间需要 - 进行连接 ...

markdown 生成目录_github上如何为markdown文件生成目录

weixin_39999586的博客

11-28

234

写在前面熟悉markdown都知道可以使用[TOC]自动生成markdown文件的标题目录，比如在typora，vscode(需要插件)等本地编辑器中，或者在优快云等网页编辑器中，但是github却不支持[TOC]标签，至于为什么不支持感兴趣的可以深入搜索，而相应的解决方法之一就是为md文件自动生成适用于github的目录。网页生成有没有这样自动生成目录的操作呢？答案是有的，其中之一就是在线的g...

【Markdown】github上如何为markdown文件生成目录

豆芽菜

11-23

767

熟悉markdown都知道可以使用[TOC]自动生成markdown文件的标题目录，比如在typora，vscode(需要插件)等本地编辑器中，或者在优快云等网页编辑器中，但是github却不支持[TOC]标签。笔者目前了解到的最最最简单的莫过于VSCode中的Markdown All in One 插件了，安装后点开md文件，然后快捷键CTRL(CMD)+SHIFT+P，输入Markdown All in One: Create Table of Contents回车即可。

gitblog_00067的博客

06-15

933

探索 `remark-toc`：Markdown 中的自动化目录生成器

gitblog_00047的博客

04-27

1112

探索 remark-toc：Markdown 中的自动化目录生成器在日常文档编写中，尤其是技术写作，一个清晰、整洁的目录结构往往能提升阅读体验。remark-toc 是一款基于 Markdown 的工具，它允许你在 Markdown 文件中自动生成 TOC（Table of Contents, 目录）, 使得组织和导航长篇文章变得轻而易举。项目简介是 remark 生态系统的一部分，一个用于...

【chatgpt】markdown生成目录[TOC]