Markdown Logo with list

Markdown子目录工具


生成子文件和文件夹的 markdown 列表,并将其保存到 markdown 文件。
当需要在 readme.md 中添加索引时很有用。
在这里可用作命令行工具。

示例

假设存在一个 readme.md 文件

My favourite things are:
<!-- markdown-children:start -->
<!-- markdown-children:end -->
并且它位于此目录中 Directory of files and folders
当调用 Markdown子目录工具 时
try MarkdownChildren().process(.init(
    url: URL(string: "../readme.md",
    nameType: .useH1,
    tagStart: "<!-- markdown-children:start -->",
    tagEnd: "<!-- markdown-children:end -->",
    saver: saver
))

那么 readme.md 变成

My favourite things are:
<!-- markdown-children:start -->
- [Animals](animals.md)
- animals
  - pets
    - [Cats](animals/pets/cats.md)
    - [Dogs](animals/pets/dogs.md)
  - zoo
    - [Tiger](animals/zoo/tiger.md)
- [Clothes](clothes.md)
- clothes
  - summer
    - [Dress](clothes/summer/dress.md)
    - [Hat](clothes/summer/hat.md)
  - winter
    - [Jumper](clothes/winter/jumper.md)
    - [Pants](clothes/winter/pants.md)
<!-- markdown-children:end -->

安装

SPM

将以下内容添加到您的项目

https://github.com/ptrkstr/MarkdownChildrenKit

待办事项