# vuepress-plugin-child-toc

> Vuepress plugin to add a global Table of Contents component

Latest version **0.1.2** (published 2020-11-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install vuepress-plugin-child-toc
pnpm add vuepress-plugin-child-toc
yarn add vuepress-plugin-child-toc
bun add vuepress-plugin-child-toc
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-11-09 |
| First published | 2020-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ludovic Dehon |
| Maintainers | tchiotludo |
| Keywords | vuepress, toc |

## Links

- npm: https://www.npmjs.com/package/vuepress-plugin-child-toc
- Repository: https://github.com/tchiotludo/vuepress-plugin-child-toc
- Homepage: https://github.com/tchiotludo/vuepress-plugin-child-toc#readme
- Issues: https://github.com/tchiotludo/vuepress-plugin-child-toc/issues
- npm.io page: https://npm.io/package/vuepress-plugin-child-toc

## Recent versions

- 0.1.2 (latest) — 2020-11-09
- 0.1.1 — 2020-11-09
- 0.1.0 — 2020-11-09

## README

# vuepress-plugin-child-toc
> Display child page table of content on your vuepress documentation

[![license](https://img.shields.io/github/license/tchiotludo/vuepress-plugin-child-toc.svg?maxAge=2592000&style=flat-square)](https://github.com/tchiotludo/vuepress-plugin-child-toc/blob/master/LICENSE)
[![npm](https://img.shields.io/npm/v/vuepress-plugin-child-toc.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/vuepress-plugin-child-toc)
![npm downloads](https://img.shields.io/npm/dy/vuepress-plugin-child-toc)
[![Dependency Status](https://david-dm.org/tchiotludo/vuepress-plugin-child-toc.svg?style=flat-square)](https://david-dm.org/tchiotludo/vuepress-plugin-child-toc)
[![devDependency Status](https://david-dm.org/tchiotludo/vuepress-plugin-child-toc/dev-status.svg?style=flat-square)](https://david-dm.org/tchiotludo/vuepress-plugin-child-toc#info=devDependencies)

## Requirements
* This plugin requires VuePress >= **1.0.0**.

## Features

Add a `<ChildTableOfContents />` component that you can use in your markdown in order to get a Table of Contents for all the child page (meaning url starting with the current page url).

## Install

```bash
npm i vuepress-plugin-child-toc
```

## Usage

Using this plugin:

```javascript
// .vuepress/config.js
module.exports = {
  plugins: ['vuepress-plugin-child-toc']
}
```

then add your table of components where you want in your markdown pages:

```mdx
# All child page table of contents
<ChildTableOfContents />

# All child page table of contents with max 2 max distance level
<ChildTableOfContents :max="2"/>

# Add internal, anchor link in the table of contents
<ChildTableOfContents :header="true"/>

# Display Child TOC for this specific page
<ChildTableOfContents pageUrl="/blogs/"/>
```

## Inspiration
Largely inspired from plugin [vuepress-plugin-global-toc](https://github.com/sylvainpolletvillard/vuepress-plugin-global-toc)

## License

---
_Source: https://npm.io/package/vuepress-plugin-child-toc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._