
Ultra-smooth table of contents generator for your docs and blogs.
Documentation | CodePen
🪄 Features
- Ultra-smooth: It accurately highlights exactly where you are on the page, resulting in an ultra-smooth user experience.
- Auto-scroll: Neotoc keeps itself in sync with your scroll, so you never have to hunt for your position.
- Foldable: Easily fold and unfold nested sections.
- Opinionated: Neotoc focuses on a single DOM structure and convention of style, so it stays efficient and free of bloat.
- Ready-made styles: Get styled easily with carefully crafted base styles and color schemes.
- Framework-agnostic: Neotoc is not tied to any particular library or framework, freeing you to use it anywhere DOM exists.
- Zero dependencies: Built entirely from scratch, with no external dependencies.
- Browser support: Works smoothly across all modern and popular web browsers.
- Lightweight: The JavaScript bundle is 4.2KB, with ready-made CSS bundle weighing about 2.1KB (both minified and gzipped).
- Accessible: Accessible with keyboards, touchscreens and screen readers.
📖 Documentation
For documentation, visit neotoc.vercel.app.
🤝 Contributing
Interested in contributing? Get started by reading CONTRIBUTING.md.
📄 License
The Neotoc is licensed under the MIT License.
🏅 Acknowledgments
The TOC tree view is inspired by GitHub’s file tree interface.