neotoc/README.md

Neotoc is a smoothly animated, foldable table of contents generator.

<p align="center">
  <img src="https://github.com/ashutoshbw/neotoc/blob/main/.github/assets/logo-dark.svg" width="200px" align="center" alt="Neotoc Logo" />
  <h1 align="center">Neotoc</h1>
  <p align="center">
    Smoothly animated, foldable table of contents generator
    <br/>
    <b><a href="https://neotoc.vercel.app/">Documentation</a></b>
  </p>
</p>

<div align="center">
  <img src="https://img.shields.io/npm/v/neotoc" alt="npm version">
  <img src="https://img.shields.io/github/license/ashutoshbw/neotoc" alt="GitHub license">
  <img src="https://img.shields.io/npm/dw/neotoc" alt="npm weekly downloads">
  <img src="https://img.shields.io/bundlephobia/minzip/neotoc" alt="bundle size">
  <img src="https://img.shields.io/github/stars/ashutoshbw/neotoc" alt="GitHub Repo stars">
</div>

<br/>

![Neotoc Demo](https://github.com/ashutoshbw/neotoc/blob/main/.github/assets/neotoc-demo.gif)

Check out [this CodePen](https://codepen.io/ashutoshbw/pen/Jojvvbp) if you’re feeling impatient!

To try it out in the comfort of your favorite code editor run the following in your terminal to scaffold a Vite-powered Neotoc playground:

```sh
npx create-neotoc
```

**Note**: You will node [NodeJS](https://nodejs.org/en) installed on your system to have the [`npx`](https://docs.npmjs.com/cli/v11/commands/npx) command available.

It will prompt you to set it up, and you’ll see something like this:

![create-neotoc](https://github.com/ashutoshbw/neotoc/blob/main/.github/assets/create-neotoc.png)

Please give it a star on [GitHub](https://github.com/ashutoshbw/neotoc)!

Interested in contributing? Get started by reading [CONTRIBUTING.md](https://github.com/ashutoshbw/neotoc/blob/main/CONTRIBUTING.md).