-
Notifications
You must be signed in to change notification settings - Fork 501
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a64f442
commit acfb6e0
Showing
2 changed files
with
16 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ | |
|
|
||
| English | [简体中文](./README_CN.md) | ||
|
|
||
| Remix Icon is a set of open-source neutral-style system symbols for designers and developers. Unlike a patchwork icon library, 2600+ icons are all elaborately crafted so that they are born with the gene of readability, consistency and perfect pixels. Each icon was designed in "Outlined" and "Filled" styles based on a 24x24 grid. Of course, all the icons are free for both personal and commercial use. | ||
| Remix Icon is a set of open-source neutral-style system symbols for designers and developers. Unlike a patchwork icon library, 2700+ icons are all elaborately crafted so that they are born with the genes of readability, consistency, and perfect pixels. Each icon was designed in "Outlined" and "Filled" styles based on a 24x24 grid. Of course, all the icons are free for both personal and commercial use. | ||
|
|
||
| [](https://remixicon.com) | ||
| View the full set of Remix Icons at [remixicon.com](https://remixicon.com). | ||
|
|
@@ -18,7 +18,7 @@ View the full set of Remix Icons at [remixicon.com](https://remixicon.com). | |
|
|
||
| Just click the icons you want from [remixicon.com](https://remixicon.com), and then you can download the icons in SVG or PNG format. | ||
|
|
||
| Designers can click the `Copy SVG` button and then press `⌘+V` or `Ctrl+V` to paste the vector graphic into your design tool directly, easy and simple. | ||
| Designers can click the `Copy SVG` button and then press `⌘+V` or `Ctrl+V` to paste the vector graphic into your design tool directly, it is easy and simple. | ||
|
|
||
| > We recommend that designers download or copy icons from our website when needed instead of managing all of them in a local folder. The website's search engine allows you to quickly locate the icon you are looking for and the icons on the website are being continuously updated. | ||
| > | ||
|
|
@@ -50,20 +50,20 @@ import 'remixicon/fonts/remixicon.css' | |
| #### CDN | ||
|
|
||
| Copy the following code and add it to the <head> tag of your html document. | ||
| Copy the following code and add it to the <head> tag of your HTML document. | ||
|
|
||
| ```html | ||
| <link | ||
| href="https://cdn.jsdelivr.net/npm/remixicon@4.0.0/fonts/remixicon.css" | ||
| href="https://cdn.jsdelivr.net/npm/remixicon@4.1.0/fonts/remixicon.css" | ||
| rel="stylesheet" | ||
| /> | ||
| ``` | ||
|
|
||
| > The `@3.7.0` in the CDN link can be changed to any history version we've published. | ||
| > The `@4.1.0` in the CDN link can be changed to any history version we've published. | ||
| #### Download Manually | ||
|
|
||
| Download [`remixicon.css`](https://cdn.jsdelivr.net/npm/[email protected]/fonts/remixicon.css) file, add it to the <head> tag of your html document. | ||
| Download [`remixicon.css`](https://cdn.jsdelivr.net/npm/[email protected]/fonts/remixicon.css) file, and add it to the <head> tag of your HTML document. | ||
|
|
||
| #### Use | ||
|
|
||
|
|
@@ -80,7 +80,7 @@ Add icon with class name, class name rule: ri-{name}-{style} | |
| #### Sizing | ||
|
|
||
| RemixIcon can be resized by css class integrated by `remixicon.css` . Icons inherit the `font-size` of their parent container and with the following classes you can increase or decrease the size of icons relative to that inherited `font-size`. You can also use `ri-fw` class for a fixed width for icons. For example: | ||
| RemixIcon can be resized by CSS class integrated by `remixicon.css` . Icons inherit the `font-size` of their parent container and with the following classes, you can increase or decrease the size of icons relative to that inherited `font-size`. You can also use `ri-fw` class for a fixed width for icons. For example: | ||
|
|
||
| ```html | ||
| <div style="font-size: 24px;"> | ||
|
|
@@ -102,7 +102,7 @@ RemixIcon can be resized by css class integrated by `remixicon.css` . Icons inhe | |
| ### SVG Sprite Usage | ||
|
|
||
| Download [`remixicon.symbol.svg`](https://cdn.jsdelivr.net/npm/[email protected]/fonts/remixicon.symbol.svg) file into your project directory，use icons with the `<use>` element, such as: | ||
| Download [`remixicon.symbol.svg`](https://cdn.jsdelivr.net/npm/[email protected]/fonts/remixicon.symbol.svg) file into your project directory, use icons with the `<use>` element, such as: | ||
|
|
||
| ```html | ||
| <svg class="remix"> | ||
|
|
@@ -178,25 +178,25 @@ import { RiHeartFill } from "@remixicon/vue"; | |
|
|
||
| ## Contributing | ||
|
|
||
| > **Note:** In order to ensure the quality of each icon, we currently do not accept third-party drawn icons. If you want to contribute an icon to Remix Icon, you can create an [issue](https://github.com/Remix-Design/remixicon/issues) with a screenshot or url to your svg-format file. If you are not familiar with github, you can also email us directly `[email protected]`. | ||
| > **Note:** In order to ensure the quality of each icon, we currently do not accept third-party drawn icons. If you want to contribute an icon to Remix Icon, you can create an [issue](https://github.com/Remix-Design/remixicon/issues) with a screenshot or URL to your svg-format file. If you are not familiar with GitHub, you can also email us directly `[email protected]`. | ||
| ### Icon Request | ||
|
|
||
| If there is no suitable icon for your usage scenario, you can create an [issue](https://github.com/Remix-Design/remixicon/issues) with a title of "Icon request: `<Icon name>`" and fill the issue template. | ||
| If there is no suitable icon for your usage scenario, you can create an [issue](https://github.com/Remix-Design/remixicon/issues) with the title of "Icon request: `<Icon name>`" and fill in the issue template. | ||
|
|
||
| > RemixIcon is mainly focuses on user interface icons. If we did not include the logo icons you were looking for, I recommend this icon library - [Simple Icons](https://github.com/simple-icons/simple-icons) | ||
| > RemixIcon is mainly focused on user interface icons. If we did not include the logo icons you were looking for, I recommend this icon library - [Simple Icons](https://github.com/simple-icons/simple-icons) | ||
| ### Icon Search Keywords | ||
|
|
||
| We use [`tags.json`](https://github.com/Remix-Design/remixicon/blob/master/tags.json) file to manage the search keywords of our [website](https://remixicon.com). But at the moment, we don't have a good automatic method to complete the keywords for each icon. So we hope you can help us to improve the `tags.json` file by creating [issues](https://github.com/Remix-Design/remixicon/issues), sending emails or "pull request" of tags.json file to make the search engine better. Especially when one of our icons matches your scene but you don't find the icon with your keywords. | ||
| We use [`tags.json`](https://github.com/Remix-Design/remixicon/blob/master/tags.json) file to manage the search keywords of our [website](https://remixicon.com). But at the moment, we don't have a good automatic method to complete the keywords for each icon. So we hope you can help us to improve the `tags.json` file by creating [issues](https://github.com/Remix-Design/remixicon/issues), sending emails, or "pull request" of tags.json file to make the search engine better. Especially when one of our icons matches your scene but you don't find the icon with your keywords. | ||
|
|
||
| ## Sub-projects | ||
|
|
||
| [RemixIcon-Slides](https://github.com/Remix-Design/RemixIcon-Slides) PowerPoint and Keynote verison of Remix Icon. | ||
| [RemixIcon-Slides](https://github.com/Remix-Design/RemixIcon-Slides) PowerPoint and Keynote version of Remix Icon. | ||
|
|
||
| ## License | ||
|
|
||
| Remix Icon is based on the [Apache License Version 2.0](https://github.com/Remix-Design/remixicon/blob/master/License) license. Feel free to use these icons in your products and distribute them. We would be very grateful if you mention "Remix Icon" in your product info, but it's not required. The only thing we ask is that these icons are not for sale. | ||
| Remix Icon is based on the [Apache License Version 2.0](https://github.com/Remix-Design/remixicon/blob/master/License) license. Feel free to use these icons in your products and distribute them. We would be very grateful if you mentioned "Remix Icon" in your product info, but it's not required. The only thing we ask is that these icons are not for sale. | ||
|
|
||
| ## Support Us | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters