Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/houbb/markdown-toc
🎄Generate toc for github markdown file.（为 markdown 文件生成 toc 目录）
https://github.com/houbb/markdown-toc
github java jdk markdown md toc
Last synced: about 2 hours ago
JSON representation
🎄Generate toc for github markdown file.（为 markdown 文件生成 toc 目录）
- Host: GitHub
- URL: https://github.com/houbb/markdown-toc
- Owner: houbb
- License: apache-2.0
- Created: 2018-01-30T06:05:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-10T14:26:38.000Z (over 1 year ago)
- Last Synced: 2024-09-24T21:13:45.591Z (about 7 hours ago)
- Topics: github, java, jdk, markdown, md, toc
- Language: Java
- Homepage: https://houbb.github.io/opensource/markdown-toc/
- Size: 224 KB
- Stars: 167
- Watchers: 6
- Forks: 257
- Open Issues: 2
-
Metadata Files:
- Readme: README-ENGLISH.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Table of Contents
* [markdown-toc](#markdown-toc)
* [The Features](#the-features)
* [environmental dependence](#environmental-dependence)
* [the JDK](#the-jdk)
* [Maven](#maven)
* [quick start](#quick-start)
* [maven introduced](#maven-introduced)
* [md file](#md-file)
* [quick start](#quick-start-1)
* [attribute configuration](#attribute-configuration)
* [attribute description](#attribute-description)
* [return value description](#return-value-description)
* [test cases](#test-cases)
* [other](#other)
# markdown-toc
```
_ __ ___ __ _ _ __| | ____| | _____ ___ __ | |_ ___ ___
| '_ ` _ \ / _` | '__| |/ / _` |/ _ \ \ /\ / / '_ \ _____| __/ _ \ / __|
| | | | | | (_| | | | < (_| | (_) \ V V /| | | |_____| || (_) | (__
|_| |_| |_|\__,_|_| |_|\_\__,_|\___/ \_/\_/ |_| |_| \__\___/ \___|
```
[](http://mvnrepository.com/artifact/com.github.houbb/markdown-toc)
[](https://www.travis-ci.org/houbb/markdown-toc?branch=release_1.0.2)
[](https://coveralls.io/github/houbb/markdown-toc?branch=release_1.0.2)
Markdown-to-toc can be used to generate a directory of the Markdown page for github page rendering.
- README
[中文说明](README.md) | [English Readme](README-ENGLISH.md)
> note
For the title, there are two kinds of md grammar [setext] (http://docutils.sourceforge.net/mirror/setext.html)
And [atx] (http://www.aaronsw.com/2002/atx/) mode.
**atx** form is only supported temporarily.
## The Features
- Github Markdown file one click to generate the directory
- fluent and elegant writing is supported
- support multiple generation
- support the generation of duplicate titles
- supports filtering of special characters
- supports specifying different file codes
- supports batch processing of files in folders (you can specify whether subfolder files are included)
- supports writing to files, returns contents of the directory, and allows users to process by themselves
- support multi-threads for directory files.
- support i18n
- support gen toc number
# environmental dependence
## the JDK
JDK8+, make sure the JDK is set up correctly.
Note: If you are use jdk7，download this code and compile by yourself.
## Maven
Jars are managed uniformly using [Maven](http://maven.apache.org/).
Change log
> [change log](doc/changelog/CHANGELOG-ENGLISH.MD)
# quick start
## maven introduced
```xml
com.github.houbb
markdown-toc
${maven-version}
```
## md file
The project for the support of md file name suffix `.md` or `.markdown`
## quick start
- single file
```Java
AtxMarkdownToc.newInstance().genTocFile(path);
```
Where path is the path of md file
- specified folder
```Java
AtxMarkdownToc.newInstance().genTocFile(path);
```
Where path is the parent class folder of the md file
# attribute configuration
- code examples
```Java
AtxMarkdownToc.newInstance()
.charset("UTF-8")
.write(true)
.subTree(true);
```
## attribute description
| 序号 | 属性 | 默认值 | 说明 |
|:----|:----|:----|:----|
| 1 | charset | `UTF-8` | file charset |
| 2 | write | `true` | will toc written to the file (default write) |
| 3 | subTree | `true` | does it include subfolders(default includes) |
| 3 | order | `false` | does it gen toc order num(default false, since 1.0.5) |
## return value description
`genTocFile()` returns TocGen, `genTocDir()` returns List
- TocGen attribute description
| 序号 | 属性 | 类型 | 说明 |
|:----|:----|:----| :----|
| 1 | filePath | String | current md filePath |
| 2 | tocLines | List | current md file toc content |
# test cases
[a single file - directory to generate test cases](https://github.com/houbb/markdown-toc/blob/release_1.0.2/src/test/java/com/github/houbb/markdown/toc/core/impl/AtxMarkdownTocFileTest.java)
[folder - directory to generate test cases](https://github.com/houbb/markdown-toc/blob/release_1.0.2/src/test/java/com/github/houbb/markdown/toc/core/impl/AtxMarkdownTocDirTest.java)
# other
> [Issues & Bugs] (https://github.com/houbb/markdown-toc/issues)