Markdown 目录生成器

1.0.0 2016-03-02 05:21 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:47:30 UTC


README

为您的 Markdown 文件生成目录。

https://github.com/KeyboardCowboy/TopDown

这受到 GitHub wiki 的启发。它的实用性因侧边栏与 wiki 页面没有任何关联而被削弱。你可以通过更改页面名称来断开链接。使用 TopDown,你可以通过简单的命名约定生成简单的目录,例如 GitHub 中的 _Sidebar.md 文件。

工作原理

  1. 安装此库。

  2. 创建一个 PHP 文件并包含 TopDown.php。

  3. 告诉 TopDown 文件所在位置和要创建的 TOC 文件名。

     $sidebar = new TopDown('/path/to/files');
     $sidebar->create('TableOfContents.md');
    

这将创建文件 /path/to/files/TableOfContents.md

使用 GitHub

GitHub wiki 是独立的仓库。请将您的本地机器上的文件进行检查,而不是在 UI 中编辑文件。完成创建或编辑文件后,运行 TopDown,您的侧边栏就准备好了!

有一个子类可以使生成 GitHub Wiki 侧边栏变得非常简单。

  1. 检查您的 wiki 仓库并 cd 进入。

  2. 运行 composer require keyboardcowboy/topdown

  3. 将一个 php 文件,例如 buildSidebar.php 添加到仓库中,然后复制并粘贴此片段

     <?php
     require_once 'vendor/keyboardcowboy/topdown/TopDown.php';
     
     $sidebar = new GitHubWikiSidebar();
     $sidebar->create();
    

现在,只需运行 php buildSidebar.php!就这样!

文件名

TopDown 依赖于简单的命名约定来生成层次结构。默认情况下,使用双短横线作为层次分隔符,但你也可以告诉 TopDown 使用任何字符串作为分隔符。例如

contributing.md
contributing--configuration.md
contributing--configuration--advanced.md
contributing--configuration--beginner.md
contributing--getting-started.md
contributing--giving-back.md
more.md

将生成如下目录

  • 贡献
    • 配置
      • 高级
      • 初学者
    • 入门
    • 回馈
  • 更多

TopDown 从给定的目录自上而下读取文件,通常是按字母顺序,因此要重新排列项目,只需在它们前面加上数字。

contributing.md
contributing--1-getting-started.md
contributing--2-configuration.md
contributing--2-configuration--1-beginner.md
contributing--2-configuration--2-advanced.md
contributing--3-giving-back.md
more.md

以数字和点或短横线开头的文件名将修剪掉这部分以生成链接名称。

  • 贡献
    • 入门
    • 配置
      • 初学者
      • 高级
    • 回馈
  • 更多

选项

TopDown::title 字符串 : 设置文件的自定义标题。默认为“目录”

TopDown::separator 字符串 : 设置自定义分隔符以确定层次结构。默认为 --

TopDown::format 整数 : 设置列表格式。默认为 TopDown::UNORDERED

TopDown::fileExt 布尔值 : 是否在链接中构建文件扩展名。GitHub 不在其 wiki 页面 URL 上使用 .md 文件扩展名。

TopDown::ignore 数组 : 要忽略的文件名数组。

TopDown::footer 字符串 : 用于生成目录下方页脚的自定义文件。使用 FALSE 禁用页脚内容。