如何在github中toc • Worktile社区

fiy

Worktile&PingCode市场小伙伴

在Github中创建目录（Table of Contents, TOC）可以帮助读者更快地浏览和导航你的项目或文档。下面是一些在Github中添加TOC的方法：

方法一：使用Github支持的自动生成TOC的特殊标记

1. 在你的Markdown文档中，使用`[TOC]`标记插入TOC的位置。

2. 在你的项目的仓库中，打开你想要添加TOC的Markdown文件。

3. 将`[TOC]`标记插入到你想要显示TOC的位置，并提交保存。

4. 刷新Markdown文件的页面，你将看到TOC已经被自动生成了。

方法二：使用第三方库或插件

1. 如果使用的是Jekyll，可以使用jekyll-toc插件。只需在项目的`_config.yml`文件中添加如下代码：

“`
plugins:
– jekyll-toc
“`

2. 安装并配置其他第三方的Markdown插件，如markdown-toc或remark-toc。

3. 根据插件的具体文档提供的方法，在你的Markdown文件中插入插件指定的标记，以生成TOC。

方法三：手动创建链接

1. 手动在Markdown文件中添加标题。

2. 为每个标题添加唯一的id，如`

Example

`。

3. 在文档的适当位置，创建TOC并添加链接指向各个标题。

“`
* [Example](#example)
“`

4. 保存文件，并通过浏览器打开查看TOC是否正常显示。

无论使用哪种方法，添加TOC后，你可能还需要对TOC进行样式和布局的调整，以适应你项目或文档的风格。你可以在Markdown文件中直接使用CSS样式或者利用Github提供的页面布局功能进行设置。

请注意，以上这些方法都是在Github中添加TOC的常用方式，你可以根据自己的需求选择其中的一种或多种方法来使用。

2年前 0条评论

worktile

Worktile官方账号

在 GitHub 上创建目录（Table of Contents）可以方便地导航和浏览你的代码仓库中的文件和文档。以下是如何在 GitHub 中创建目录的一些方法：

1. 使用 Markdown 语法创建目录：在 Markdown 文件中，你可以使用 `#` 标识符来表示标题，不同数量的 `#` 对应不同级别的标题。例如，使用 `#` 表示一级标题，使用 `##` 表示二级标题，以此类推。当你的 Markdown 文件中有多个标题时，可以使用这些标题创建目录。方法是在文件的适当位置，使用 `[TOC]` 标记，这样在预览或渲染 Markdown 文件时，就会生成一个目录。

例如：
“`markdown
# 一级标题

## 二级标题

[TOC]

### 三级标题

此处是内容…

#### 四级标题

此处是内容…
“`

2. 使用 GitHub Actions 自动生成目录：GitHub Actions 是一种自动化工作流程，可以自动执行各种操作。你可以在你的代码仓库中创建一个 GitHub Actions 工作流程，来自动创建并更新目录。有许多第三方的 GitHub Actions 扩展可以实现这个目的，如 `github-training/auto-toc`、`ekalinin/github-markdown-toc`等。

例如，你可以在代码仓库中创建一个 `.github/workflows/toc.yml` 文件来定义 GitHub Actions 工作流程，内容如下：
“`yaml
name: Auto TOC

on:
push:
branches:
– main

jobs:
build:
runs-on: ubuntu-latest
steps:
– name: Checkout repository
uses: actions/checkout@v2

– name: Generate TOC
uses: github-training/auto-toc@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
“`

3. 使用第三方脚本生成目录：除了使用 GitHub Actions，你还可以使用一些第三方脚本来生成目录。这些脚本可以在本地或者在远程服务器上运行。你可以使用像 `doctoc` 这样的工具来生成目录。`doctoc` 是一个命令行工具，它可以扫描 Markdown 文件并自动生成目录。

例如，在命令行中运行以下命令来使用 `doctoc`：
“`shell
$ npx doctoc ./README.md
“`

4. 使用 GitHub 扩展：GitHub 有一些扩展可以帮助你在代码仓库中生成目录。你可以在 GitHub Marketplace 中搜索并安装这些扩展。例如，`Markdown TOC` 是一个流行的扩展，可以帮助你快速生成目录。

5. 手动创建目录：如果你不想使用自动化工具或者扩展，你也可以手动创建目录。在 Markdown 文件中，你可以使用链接来手动创建目录。首先，为每个标题创建一个唯一的链接标识符，在目录部分使用这些链接标识符创建链接。这需要一些手动工作，但是可以确保目录的准确性和精确性。

例如：
“`markdown
[一级标题](#一级标题)
[二级标题](#二级标题)
[三级标题](#三级标题)
[四级标题](#四级标题)
“`

以上是在 GitHub 中创建目录的一些方法。你可以根据自己的需求选择适合的方法来为你的代码仓库添加目录。

2年前 0条评论

不及物动词

这个人很懒，什么都没有留下～

如何在GitHub中生成Table of Contents (ToC)

在GitHub上编写和维护代码文档时，常常需要添加Table of Contents（目录），以方便读者快速浏览和定位到文档中的不同部分。虽然在GitHub上自动生成目录并不是一项内置功能，但我们可以通过使用一些工具和技巧来实现这个目标。

下面是一种常用的方法来在GitHub中生成Table of Contents：

1. 使用Markdown语法创建链接

Markdown是GitHub上广泛使用的文本格式，在Markdown文档中，我们可以使用标题标记（例如`#`、`##`等）创建标题，并在需要添加目录的位置添加链接。具体操作如下：

– 使用`#`标记创建主标题，在每个主标题下面使用`##`标记创建子标题，以此类推，以创建层次化的标题结构。示例如下：

“`markdown
# 主标题

## 子标题1

## 子标题2

### 孙子标题1

## 子标题3
“`

– 在文档的开头或末尾创建一个Table of Contents（ToC）的部分，并使用链接语法将每个标题与相应的位置链接起来。示例如下：

“`markdown
# Table of Contents

– [子标题1](#子标题1)
– [子标题2](#子标题2)
– [孙子标题1](#孙子标题1)
– [子标题3](#子标题3)
“`

2. 使用工具自动生成目录链接

手动创建目录链接可能会很繁琐且容易出错，因此，为了提高效率，我们可以使用一些工具来自动生成目录链接。下面介绍两个常用的工具：

– markdown-toc：markdown-toc是一个Node.js模块，可以在命令行中使用，用于为Markdown文档自动生成Table of Contents。

– 首先，确保你的机器上已经安装了Node.js和npm（Node.js的包管理器）。
– 打开终端，使用以下命令来全局安装markdown-toc：

“`shell
npm install -g markdown-toc
“`

– 导航到你的GitHub仓库中的Markdown文件所在的目录，并使用以下命令生成Table of Contents：

“`shell
markdown-toc -i README.md
“`

这将在你的Markdown文件中自动插入一个名为`Table of Contents`的标题，并在其下面生成目录链接。

– `[TOC]`：这是一种在Markdown文件中自动生成目录的另一种方法。只需在你的文档中添加`[TOC]`标记，markdown编辑器会自动将其替换为生成的目录。然而，需要注意的是，这种方法只在某些Markdown编辑器中有效，并不适用于所有情况。

无论你选择使用哪种方法，在向GitHub仓库提交你的Markdown文件之前，都应该确保你的Table of Contents能够正确显示，并且所有的链接都能够正常跳转。这将使你的代码文档更加易读和易用。

2年前 0条评论