csdn 不支持github 的目录结构。

怼烎@ 2023-06-09 10:12 19阅读 0赞

# 总结 #

# Table of Contents #

*  markdown-toc
    
     *  The Features
 *  environmental dependence
    
     *  the JDK
     *  Maven
 *  quick start
    
     *  maven introduced
     *  md file
     *  \[quick start\](\#quick start-1)
 *  attribute configuration
    
     *  attribute description
     *  return value description
 *  test cases
 *  other

# markdown-toc #

_ __ ___   __ _ _ __| | ____| | _____      ___ __       | |_ ___   ___ 
     | '_ ` _ \ / _` | '__| |/ / _` |/ _ \ \ /\ / / '_ \ _____| __/ _ \ / __|
     | | | | | | (_| | |  |   < (_| | (_) \ V  V /| | | |_____| || (_) | (__ 
     |_| |_| |_|\__,_|_|  |_|\_\__,_|\___/ \_/\_/ |_| |_|      \__\___/ \___|

[![Maven Central][]][Maven Central 1]  
[\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-r45lEGNc-1571545581607)(https://www.travis-ci.org/houbb/markdown-toc.svg?branch=release\_1.0.2)\]][img-r45lEGNc-1571545581607_https_www.travis-ci.org_houbb_markdown-toc.svg_branch_release_1.0.2]  
[\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-LVut6cTI-1571545581608)(https://coveralls.io/repos/github/houbb/markdown-toc/badge.svg?branch=release\_1.0.2)\]][img-LVut6cTI-1571545581608_https_coveralls.io_repos_github_houbb_markdown-toc_badge.svg_branch_release_1.0.2]

Markdown-to-toc can be used to generate a directory of the Markdown page for github page rendering.

*  README

中文说明 | English Readme

> 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

\-…

# environmental dependence #

## the JDK ##

JDK7+, make sure the JDK is set up correctly.

## Maven ##

Jars are managed uniformly using [Maven][].

Change log

> change log

# quick start #

## maven introduced ##

<dependency>
        <groupId>com.github.houbb</groupId>
        <artifactId>markdown-toc</artifactId>
        <version>1.0.2</version>
    </dependency>

## md file ##

The project for the support of md file name suffix `.md` or `.markdown`

## quick start ##

*  single file

AtxMarkdownToc.newInstance().genTocFile(path);

Where path is the path of md file

*  specified folder

AtxMarkdownToc.newInstance().genTocFile(path);

Where path is the parent class folder of the md file

# attribute configuration #

*  code examples

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

## attribute description ##

<table> 
 <thead> 
  <tr> 
   <th align="left">序号</th> 
   <th align="left">属性</th> 
   <th align="left">默认值</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">1</td> 
   <td align="left">charset</td> 
   <td align="left"><code>UTF-8</code></td> 
   <td align="left">file charset</td> 
  </tr> 
  <tr> 
   <td align="left">2</td> 
   <td align="left">write</td> 
   <td align="left"><code>true</code></td> 
   <td align="left">will toc written to the file (default write)</td> 
  </tr> 
  <tr> 
   <td align="left">3</td> 
   <td align="left">subTree</td> 
   <td align="left"><code>true</code></td> 
   <td align="left">does it include subfolders(default includes)</td> 
  </tr> 
 </tbody> 
</table>

## return value description ##

`genTocFile()` returns TocGen, `genTocDir()` returns List

*  TocGen attribute description

<table> 
 <thead> 
  <tr> 
   <th align="left">序号</th> 
   <th align="left">属性</th> 
   <th align="left">类型</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">1</td> 
   <td align="left">filePath</td> 
   <td align="left">String</td> 
   <td align="left">current md filePath</td> 
  </tr> 
  <tr> 
   <td align="left">2</td> 
   <td align="left">tocLines</td> 
   <td align="left">List</td> 
   <td align="left">current md file toc content</td> 
  </tr> 
 </tbody> 
</table>

# test cases #

[a single file - directory to generate test cases][]

[folder - directory to generate test cases][]

# other #

> \[Issues & Bugs\] (https://github.com/houbb/markdown-toc/issues)

[Maven Central]: /images/20230531/c8e080d087e24627be9e20d259395634.png
[Maven Central 1]: http://mvnrepository.com/artifact/com.github.houbb/markdown-toc
[img-r45lEGNc-1571545581607_https_www.travis-ci.org_houbb_markdown-toc.svg_branch_release_1.0.2]: https://www.travis-ci.org/houbb/markdown-toc?branch=release_1.0.2
[img-LVut6cTI-1571545581608_https_coveralls.io_repos_github_houbb_markdown-toc_badge.svg_branch_release_1.0.2]: https://coveralls.io/github/houbb/markdown-toc?branch=release_1.0.2
[Maven]: http://maven.apache.org/
[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