Skip to content

mostafa-kheibary/icon-preview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎨 icon-preview

Easily preview all your SVG icons in one beautiful local webpage!

icon-preview demo

πŸš€ Features

  • πŸ” Recursively scans a folder for .svg files
  • πŸ–ΌοΈ 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/icons

This will:

  1. Recursively find all .svg files in the given path
  2. Start a local web server
  3. Open a preview page in your default browser with all the icons

🌈 Example

icon-preview ./assets/icons

Will show a webpage like this:

πŸ“ assets/icons
β”œβ”€β”€ arrows/
β”‚   β”œβ”€β”€ arrow-left.svg
β”‚   └── arrow-right.svg
β”œβ”€β”€ social/
β”‚   β”œβ”€β”€ twitter.svg
β”‚   └── github.svg
└── logo.svg

And 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.

About

easily preview all your icon in a single web page

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published