buildix-icon-viewer
v1.0.0
Published
Effortlessly preview all your SVG icons in a clean, local web interface. <br/> <div align="center"> <img src="./assets/icon-viewer.png" alt="Icon Viewer Demo" width="80%"> </div> </br>
Readme
🧩 SVG Icon Viewer
Effortlessly preview all your SVG icons in a clean, local web interface.
🚀 Features
🔍 Automatically scans directories for .svg files (recursive)
🖼️ Displays a responsive grid of all icons in your browser
🌐 Runs a local preview server instantly
⚡ Lightweight, fast, and easy to use from the CLI
📦 Installation
npm install -g buildix-icon-viewer⚙️ How to Use
Just run the CLI with the path to your SVG directory:
buildix-icon-viewer ./path/to/iconsor
npx buildix-icon-viewer ./path/to/iconsWhat it does:
- Recursively scans for .svg files
- Launches a local web server
- Opens a preview page in your default browser
🌈 Example
buildix-icon-viewer ./assets/iconsWill show a webpage like this:
📁 assets/icons
├── 📁 navigation
│ ├── chevron-left.svg
│ └── chevron-right.svg
├── 📁 brands
│ ├── x-twitter.svg
│ └── github-mark.svg
└── company-logo.svgAnd the preview page will display all 5 icons in a grid 💫
🤝 Contributing
Found a bug or have an idea for a new feature? Contributions are welcome — feel free to open an issue or submit a pull request.
📄 License
MIT — Free to use, modify, and share.
