icon-preview
v1.1.0
Published
Easily preview all your SVG icons in one beautiful local webpage!
Readme
🎨 icon-preview
Easily preview all your SVG icons in one beautiful local webpage!
🚀 Features
- 🔍 Recursively scans a folder for
.svgfiles - 🖼️ Generates a neat preview page of all your icons
- 🌐 Serves the preview locally in your browser
- ⚡ Fast and easy to use with a single CLI command
📦 Installation
npm install -g icon-preview🧪 Usage
Just run the CLI with the path to your SVG directory:
icon-preview ./path/to/iconsThis will:
- Recursively find all
.svgfiles in the given path - Start a local web server
- Open a preview page in your default browser with all the icons
🌈 Example
icon-preview ./assets/iconsWill show a webpage like this:
📁 assets/icons
├── arrows/
│ ├── arrow-left.svg
│ └── arrow-right.svg
├── social/
│ ├── twitter.svg
│ └── github.svg
└── logo.svgAnd the preview page will display all 5 icons in a grid 💫
🛠️ Development
git clone https://github.com/your-username/icon-preview
cd icon-preview
npm install
npm run dev🤝 Contributing
Found a bug or want to add a feature? PRs and issues are welcome!
📄 License
MIT — Free to use, modify, and share.
