readme-urls
v1.1.0
Published
readME menu and sidebar generator
Downloads
43
Readme
ReadMe URLs Plugin
A dynamic sidebar generator for documentation sites that automatically creates navigation menus based on your directory structure.
Features
- 🗂️ Auto-generates sidebar navigation from your layouts directory
- ✨ Supports nested folder structures
- 🎨 Customizable icons and display names
- 🔄 Watches for file changes in development mode
- 📂 Creates
sidebar.jsonautomatically
Installation
As an NPM Package
- Install the package:
npm install readme-urlsplugin tree
your-projec/
├── templates/
│ └── default/
│ └── layouts/ # Your documentation pages
| ├── sidebar.json # Generated output
└ | ── sidebar.config.js # Optional configuration
