日常 - 自动构建 GitHub 项目的 README.md 目录

本文适合支持 Markdown 语法的文本的自动化目录构建。

结果

目录自动生成,可自动化更新。

# 目录

<!-- MarkdownTOC levels="1,2" autolink="true" -->

- [LeetCode 题解](#leetcode-%E9%A2%98%E8%A7%A3)
  - [链表](#%E9%93%BE%E8%A1%A8)
  - [栈-队列](#%E6%A0%88-%E9%98%9F%E5%88%97)
  - [堆](#%E5%A0%86)
  - [贪心算法](#%E8%B4%AA%E5%BF%83%E7%AE%97%E6%B3%95)
  - [递归-回溯-分治](#%E9%80%92%E5%BD%92-%E5%9B%9E%E6%BA%AF-%E5%88%86%E6%B2%BB)
  - [二叉树与图](#%E4%BA%8C%E5%8F%89%E6%A0%91%E4%B8%8E%E5%9B%BE)
  - [二分查找与二叉查找/排序树](#%E4%BA%8C%E5%88%86%E6%9F%A5%E6%89%BE%E4%B8%8E%E4%BA%8C%E5%8F%89%E6%9F%A5%E6%89%BE%E6%8E%92%E5%BA%8F%E6%A0%91)
  - [哈希表与字符串](#%E5%93%88%E5%B8%8C%E8%A1%A8%E4%B8%8E%E5%AD%97%E7%AC%A6%E4%B8%B2)
  - [搜索](#%E6%90%9C%E7%B4%A2)
  - [动态规划](#%E5%8A%A8%E6%80%81%E8%A7%84%E5%88%92)
- [说明](#%E8%AF%B4%E6%98%8E)
  - [项目说明](#%E9%A1%B9%E7%9B%AE%E8%AF%B4%E6%98%8E)

<!-- /MarkdownTOC -->

过程

准备工具

Sublime Text3
插件 MarkdownTOC:https://github.com/naokazuterada/MarkdownTOC

方法

如何给?Sublime Text3 安装插件?参看博客或搜索一下,给出一篇参考的博客:https://blog.csdn.net/wxl1555/article/details/69941451/

安装了 Package Control 后,使用 Ctrl + Shift + P,查找?MarkdownTOC,然后安装。
题外话:由于本人先下载 GitHub 的项目到本地,然后使用 Sublime Text3 安装的?MarkdownTOC,因此并不是很清楚它的安装机制。不过想要复现操作的话最好还是按照相同的步骤,出错率低一些。

使用

参考 MarkdownTOC 使用说明书:https://github.com/naokazuterada/MarkdownTOC/blob/master/images/capture.gif

打开一篇 Markdown 语法写的文章,将光标放到需要做成目录的标题前,按照提示的 gif 图操作即可。

总结

此前一直想找寻这种类型的工具,但是苦求不得,终于如愿以偿了。
中文的编码处理一般较难,如下面的 栈-队列 就是从 栈、队列 中改变过来,因此建议在标题项中将一些中文标点符号改成 - 表示。
题外话:下面的编码是用的 URL 编码,感兴趣可以搜一下。这个站点可以测试编码和解码:http://tool.chinaz.com/tools/urlencode.aspx

[栈-队列](#%E6%A0%88-%E9%98%9F%E5%88%97)

原文地址:https://www.cnblogs.com/chenxianbin/p/11846209.html

时间: 2024-09-29 10:00:37

日常 - 自动构建 GitHub 项目的 README.md 目录的相关文章

原来Github上的README.md文件这么有意思——Markdown语言详解

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有 过什么了解.但是在看到别人写的项目的README.md里面竟然有图片.链接什么的,就感到很好奇,这效果是什么加上去的?于是便查了一下资料,结果, 竟迁出了一门从来没有了解过的语言— —Markdown! github上的README.md文件就是使用的Markd

Github中的README.md使用的标记语言---Markdown语言

github上的README.md文件就是使用的Markdown语言编写的.它是一种易读易写的标记语言. 1.来龙去脉和语法特点 Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber).它允许人们"使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档".这种语言吸收了很多在电子邮件中已有的纯文本标记的特性. Markdown 的目标是实现「易读易写」.可读性,无论如何,都是最重要的.一份使用 Markdown 格式撰写的文件应

原来Github上的README.md文件这么有意思——Markdown语言详解(sublime text2 版本)

一直想学习 Markdown 语言,想起以前读的一篇 赵凯强 的 博客 <原来Github上的README.md文件这么有意思——Markdown语言详解>,该篇博主 使用的是Mac系统,所以推荐使用Mou,本人使用 Win7 系统所以想写一篇 sublime text2 的版本

关于github中的README.md文件

0x01 README.md文件是用Markdown语言编写的,md=Markdown; 在线编辑工具: https://stackedit.io/editor# https://maxiang.io/#笔记本和标签 关于使用语法的说明: https://github.com/guoyunsky/Markdown-Chinese-Demo 0x02 Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被「标记」.「语言」所迷惑,

iOS 给github上面的readme.md 添加图片

很多github上面的代码都带有用于说明的图片或者截图,下面说一下给readme.md 添加图片的方法 这是我的githhub上面添加的图片. 首先呢 将图片放在要上传的仓库里面,最后 push 到 github 上. 然后就能获得这个图片的地址 然后在编辑readme ![image]{(https://github.com/ButBueatiful/dotvim/raw/master/screenshots/vim-screenshot.jpg)} 将大括号里面替换为你的图片地址,就可以给r

如何在github中的readme.md加入项目截图

1. 先在之前的本地项目文件夹里创建一个存放截图的文件夹.(如img文件夹) 2. 将新增的内容通过github desktop上传到github中 3. 在github中立马能看到刚刚上传的图片,打开图片,点击Download 4. 直接复制地址栏的网址 5. 最后在README.md中修改,加上代码 ![Image text]https://img-blog.csdn.net/20180525104241175?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4

用Go构建Teamwork项目的9条教训

我们爱 Go. 在过去的一年中,我们为了构建 Teamwork Desk 多个服务,写下了将近 20 万行 Go 代码.我们已经构建了该产品的十多个小型 HTTP 服务. 为什么要使用 Go? Go 是一种快速(非常快)的静态类型编译语言,它有强大的并发模型.垃圾收集.优异的标准库.无继承.传奇的作者.多核支持以及非常不错的社区.更别说对于我们这种写 Web 应用的程序员,它的 goroutine-per-request 设置可以避免事件循环和回调地狱. 在构建系统和服务器方面尤其是微服务,Go

使用EA构建C++项目的UML图

VS自带的"查看类图"功能实在是有些太弱爆了,只能生成继承关系,连比较基本的关联关系也不能生成.下面我们看看如何使用建模工具EA来生成强大的类图. 以下示例以EA 11.0.1106为例示范 1. 新建工程 File -> New Project新建一个工程.在弹出的Model Patterns中,选中Class,点击确定后,按Alt+O打开Project Browser可以看到工程已存在. 2. 导入C++工程 Class Model上点击右键,Code Engineering

构建Springboot项目的3种方式

一.自己创建: 1.创建maven项目 2.pom.xml添加如下内容: <!--1.指定依赖都由springboot管理--> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.2.RELEASE</version> <