MingCute Docs

This repository contains detailed documentation for the MingCute Icon library. To make it easier to consult, we have categorized the documentation by usage. Here are the links to the guides for each part:

1. General Guide

Audience: All users (Web Developers, Designers)

Contains core introduction and general usage of MingCute Icon library:

• Webfont Usage: How to import icons via CSS class names.
• NPM Installation: Basic installation and configuration of the mingcute_icon package.
• SVG/PNG Download: How to get resources from the official website.
• Figma Plugin: How designers can use it in Figma.

2. React Guide

Audience: React Developers

Dedicated documentation for the @mingcute/react component library:

• Installation: Install React package using npm/yarn/pnpm.
• Basic Usage: How to import icons as components (<MingcuteFill />).
• Props Configuration: Setting properties like size, color, etc.

3. Vue Guide

Audience: Vue Developers

Dedicated documentation for the @mingcute/vue component library:

• Installation: Install Vue package using npm/yarn/pnpm.
• Basic Usage: Using icon components in Vue templates.
• Configuration & Customization: Methods for customizing color and size.

---

Official Resources

• Official Website: https://www.mingcute.com/
• GitHub Repository: https://github.com/mingcute-design/mingcute-icons
• Figma Plugin: MingCute Icon Plugin

License

MingCute Icon library is licensed under the Apache-2.0 License.