gitbook-plugin-toc

KO | EN

gitlite — search

#javascript #react #typescript #llm #golang #go #machine-learning #macos #awesome-list #pytorch #openai #ios #mcp #open-source

gitbook-plugin-toc

(★ 21)

No description available.

gitbook-plugin-toc Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# gitbook-plugin-toc

This plugin will add table of content to the page and provide navigation function inside a page.

Add `` to the markdown files. When you build the book, it will insert a table of content where you insert ``. To automatically generate a table of content for every page without adding ``, set the `auto` option to `true`.

## Preview

![image](https://raw.githubusercontent.com/whzhyh/gitbook-plugin-toc/master/example.png)

## `book.json` Configuration Examples

**Add a custom class to the TOC `ul` element:**

```
{
	"plugins": ["toc"],
	"pluginsConfig": {
		"toc": {
			"addClass": true,
			"className": "toc"
		}
	}
}
```

You can add this config to add a HTML ClassName to the TOC `ul` element

**Automatically generate TOC for every page**

```
{
	"plugins": ["toc"],
	"pluginsConfig": {
		"toc": {
			"auto": true
		}
	}
}
```

**Add title to generated TOC**

![image](https://raw.githubusercontent.com/whzhyh/gitbook-plugin-toc/master/example-title.png)

```
{
	"plugins": ["toc"],
	"pluginsConfig": {
		"toc": {
			"title": "Table of Contents",
			"addTitleClass": "toc-title"
		}
	}
}
```

In this example, `addTitleClass` is used for the HTML ClassName for the `h1` element used for the title.

gitbook-plugin-toc

gitbook-plugin-toc Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

gitbook-plugin-toc

gitbook-plugin-toc Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README