# parcel-plugin-mdx-with-toc

> An experimental Parcel v1 plugin for MDX that also exports Table of Contents

Latest version **1.0.1** (published 2020-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install parcel-plugin-mdx-with-toc
pnpm add parcel-plugin-mdx-with-toc
yarn add parcel-plugin-mdx-with-toc
bun add parcel-plugin-mdx-with-toc
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-01-25 |
| First published | 2020-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | bjoerge |
| Keywords | mdx, toc, parcel |

## Links

- npm: https://www.npmjs.com/package/parcel-plugin-mdx-with-toc
- Repository: https://github.com/bjoerge/parcel-transformer-mdx-with-toc
- Homepage: https://github.com/bjoerge/parcel-transformer-mdx-with-toc#readme
- Issues: https://github.com/bjoerge/parcel-transformer-mdx-with-toc/issues
- npm.io page: https://npm.io/package/parcel-plugin-mdx-with-toc

## Dependencies (4)

- [@mdx-js/mdx](https://npm.io/package/@mdx-js/mdx.md) ^1.5.3
- [remark-slug](https://npm.io/package/remark-slug.md) ^5.1.2
- [markdown-toc](https://npm.io/package/markdown-toc.md) ^1.2.0
- [github-slugger](https://npm.io/package/github-slugger.md) ^1.2.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-01-25
- 1.0.0 — 2020-01-20

## README

# `parcel-plugin-mdx-with-toc`

An experimental [Parcel][] v1 plugin for [MDX][] that also exports Table of Contents using [markdown-toc][] and [github-slugger][] to generate anchor names for headings.

Note: This plugin is based on the official [parcel-plugin-mdx][] and modified to also export the Table of Contents. If you don't need a Table of Contents, you are better off using the official [parcel-plugin-mdx][].

## Installation

[npm][]:

```sh
npm i -D parcel-plugin-mdx-with-toc
```

Or with [Yarn][]:

```sh
yarn add -D parcel-plugin-mdx-with-toc
```

## Usage

```jsx
// index.js
import MDXContent, {Toc} from './content.mdx';
...

render(<><Toc /><MDXContent /></>, root);
```

## License

[MIT][]

<!-- Definitions -->

[mit]: https://github.com/bjoerge/parcel-transformer-mdx-with-toc/license

[mdx]: https://github.com/mdx-js/mdx

[parcel]: https://parceljs.org

[npm]: https://docs.npmjs.com/cli/install

[yarn]: https://yarnpkg.com/lang/en/docs/cli/install/

[markdown-toc]: https://www.npmjs.com/package/markdown-toc

[github-slugger]: https://www.npmjs.com/package/github-slugger

[parcel-plugin-mdx]: https://www.npmjs.com/package/@mdx-js/parcel-plugin-mdx

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