Skip to content

Commit

Permalink
docs: change documentation url
Browse files Browse the repository at this point in the history
  • Loading branch information
Renovamen committed Apr 14, 2021
1 parent 2126acb commit 01b3172
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 30 deletions.
8 changes: 4 additions & 4 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

## 文档

[这里](https://oh-vue-icons.vercel.app/cn)查找图标和查看文档。
[这里](https://oh-vue-icons.netlify.app/cn)查找图标和查看文档。


 
Expand Down Expand Up @@ -147,7 +147,7 @@ export default {

对于 [Font Awesome 5](https://fontawesome.com/),来自 `regular` 包的图标的 `name` prop 值的前缀为 `fa-regular-` 而不是 `fa-`,如 `fa-regular-flag`。而 `solid``brands` 包的图标前缀均为 `fa-`,如 `fa-beer``fa-github`

[文档](https://oh-vue-icons.vercel.app/cn/docs#基本用法)中有更多的用法。
[文档](https://oh-vue-icons.netlify.app/cn/docs#基本用法)中有更多的用法。


 
Expand All @@ -166,7 +166,7 @@ export default {
| `title` | 图标的 title | `string` | / | / |
| `inverse` | 把图标变成白色 | `boolean` | `true` / `false` | `false` |

[文档](https://oh-vue-icons.vercel.app/cn/docs#示例)中有一些示例。
[文档](https://oh-vue-icons.netlify.app/cn/docs#示例)中有一些示例。


 
Expand Down Expand Up @@ -199,7 +199,7 @@ export default {
## 致谢

- 本项目受到了 [vue-awesome](https://github.com/Justineo/vue-awesome)[react-icons](https://github.com/react-icons/react-icons) 的启发并借鉴了它们的部分代码。
- [文档网站](https://oh-vue-icons.vercel.app/)部署在 [Vercel](https://vercel.com/) 上。
- [文档网站](https://oh-vue-icons.netlify.app/)部署在 [Netlify](https://www.netlify.com/) 上。


 
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Now the following 20 icon packs are supported:

## Documentation

Search for icons and view the documentation [here](https://oh-vue-icons.vercel.app).
Search for icons and view the documentation [here](https://oh-vue-icons.netlify.app).


 
Expand Down Expand Up @@ -147,7 +147,7 @@ The icon names should be passed using **kebab-case**.

For [Font Awesome 5](https://fontawesome.com/) icons, icons from `regular` pack have name prop values like `fa-regular-flag`. Icons from `solid` and `brands` pack have name prop values like `fa-beer` and `fa-github`.

See the [documentation](https://oh-vue-icons.vercel.app/docs#basic-usage) for more about the usage.
See the [documentation](https://oh-vue-icons.netlify.app/docs#basic-usage) for more about the usage.


 
Expand All @@ -166,7 +166,7 @@ See the [documentation](https://oh-vue-icons.vercel.app/docs#basic-usage) for mo
| `title` | Icon title | `string` | / | / |
| `inverse` | Make icon color white? | `boolean` | `true` / `false` | `false` |

Some examples could be found in the [documentation](https://oh-vue-icons.vercel.app/docs#examples).
Some examples could be found in the [documentation](https://oh-vue-icons.netlify.app/docs#examples).


 
Expand Down Expand Up @@ -199,7 +199,7 @@ Contributions are welcomed, learn how to contribute [here](CONTRIBUTING.md).
## Acknowledgements

- This project is inspired by and based on [vue-awesome](https://github.com/Justineo/vue-awesome) and [react-icons](https://github.com/react-icons/react-icons).
- The [website](https://oh-vue-icons.vercel.app/) is hosted on [Vercel](https://vercel.com/).
- The [website](https://oh-vue-icons.netlify.app/) is hosted on [Netlify](https://www.netlify.com/).


 
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Source code of the website. Powered by [Vue.js](https://vuejs.org), [Nuxt.js](https://nuxtjs.org) and [tailwindcss](https://tailwindcss.com).

The website is hosted on [Vercel](https://vercel.com/).
The website is hosted on [Netlify](https://www.netlify.com/).
2 changes: 1 addition & 1 deletion docs/content/docs-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ export default {

- 本项目受到了 [vue-awesome](https://github.com/Justineo/vue-awesome)[react-icons](https://github.com/react-icons/react-icons) 的启发并借鉴了它们的部分代码。

- 本站部署在 [Vercel](https://vercel.com/) 上。
- 本站部署在 [Netlify](https://www.netlify.com/) 上。


## 开源协议
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ or it will not be bundled, see [Nuxt's documentation](https://nuxtjs.org/docs/2.

- This project is inspired by and based on [vue-awesome](https://github.com/Justineo/vue-awesome) and [react-icons](https://github.com/react-icons/react-icons).

- This website is hosted on [Vercel](https://vercel.com/).
- This website is hosted on [Netlify](https://www.netlify.com/).


## License
Expand Down
19 changes: 10 additions & 9 deletions package/README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@

- 它是 tree-shakable 的,因此你能够仅引入你需要的图标从而减小打包体积
- 支持 Vue 2 和 Vue 3
- 支持来自 [19 个流行的图标库](#支持的图标库)20000+ 个图标
- 支持来自 [20 个流行的图标库](#支持的图标库)28000+ 个图标


 

## 支持的图标库

目前支持以下 19 个图标库:
目前支持以下 20 个图标库:

| 图标库 | 前缀 | 协议 | 图标数量 |
| ------------------------------------------------------------- | ------ | ------------------------------------------------------------- | ---------- |
Expand All @@ -35,21 +35,22 @@
| [Heroicons](https://heroicons.com/) | `hi` | [MIT](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE) | 452 |
| [Ionicons](https://ionicons.com/) | `io` | [MIT](https://github.com/ionic-team/ionicons/blob/master/LICENSE) | 1332 |
| [Line Awesome](https://icons8.com/line-awesome) | `la` | [MIT / Good Boy](https://github.com/icons8/line-awesome/blob/master/LICENSE.md) | 1544 |
| [Octicons](https://primer.style/octicons/) | `oi` | [MIT](https://github.com/primer/octicons/blob/master/LICENSE) | 209 |
| [Material Design icons](https://github.com/google/material-design-icons) | `md` | [Apache 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE) | 6911 |
| [Octicons](https://primer.style/octicons/) | `oi` | [MIT](https://github.com/primer/octicons/blob/master/LICENSE) | 219 |
| [Pokemon Icons](https://theartificial.github.io/pokemon-icons/) (Colorful)| `pi` | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) | 1453 |
| [PrimeIcons](https://github.com/primefaces/primeicons) | `pr` | [MIT](https://github.com/primefaces/primeicons/blob/master/LICENSE) | 202 |
| [Pixelarticons](https://pixelarticons.com/) | `px` | [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) | 460 |
| [Remix Icon](https://github.com/Remix-Design/RemixIcon) | `ri` | [Apache 2.0](https://github.com/Remix-Design/RemixIcon/blob/master/License) | 2271 |
| [Simple Icons](https://simpleicons.org/) | `si` | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1872 |
| [VSCode Icons](https://github.com/vscode-icons/vscode-icons) (Colorful) | `vi` | [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) | 1068 |
| [Simple Icons](https://simpleicons.org/) | `si` | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1882 |
| [VSCode Icons](https://github.com/vscode-icons/vscode-icons) (Colorful) | `vi` | [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) | 1072 |
| [Weather Icons](https://erikflowers.github.io/weather-icons/) | `wi` | [SIL OFL 1.1](http://scripts.sil.org/OFL) | 219 |


 

## 文档

[这里](https://oh-vue-icons.vercel.app/cn)查找图标和查看文档。
[这里](https://oh-vue-icons.netlify.app/cn)查找图标和查看文档。


 
Expand Down Expand Up @@ -146,7 +147,7 @@ export default {

对于 [Font Awesome 5](https://fontawesome.com/),来自 `regular` 包的图标的 `name` prop 值的前缀为 `fa-regular-` 而不是 `fa-`,如 `fa-regular-flag`。而 `solid``brands` 包的图标前缀均为 `fa-`,如 `fa-beer``fa-github`

[文档](https://oh-vue-icons.vercel.app/cn/docs#基本用法)中有更多的用法。
[文档](https://oh-vue-icons.netlify.app/cn/docs#基本用法)中有更多的用法。


 
Expand All @@ -165,7 +166,7 @@ export default {
| `title` | 图标的 title | `string` | / | / |
| `inverse` | 把图标变成白色 | `boolean` | `true` / `false` | `false` |

[文档](https://oh-vue-icons.vercel.app/cn/docs#示例)中有一些示例。
[文档](https://oh-vue-icons.netlify.app/cn/docs#示例)中有一些示例。


 
Expand Down Expand Up @@ -198,7 +199,7 @@ export default {
## 致谢

- 本项目受到了 [vue-awesome](https://github.com/Justineo/vue-awesome)[react-icons](https://github.com/react-icons/react-icons) 的启发并借鉴了它们的部分代码。
- [文档网站](https://oh-vue-icons.vercel.app/)部署在 [Vercel](https://vercel.com/) 上。
- [文档网站](https://oh-vue-icons.netlify.app/)部署在 [Netlify](https://www.netlify.com/) 上。


 
Expand Down
19 changes: 10 additions & 9 deletions package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ A [Vue](https://vuejs.org/) component for including inline SVG icons from differ

- Tree-shakable, which allows you to only import the used icons
- Supports Vue 2 and Vue 3
- Supports 20000+ icons from 19 popular icon packs, see [here](#supported-icon-packs)
- Supports 28000+ icons from 20 popular icon packs, see [here](#supported-icon-packs)


 

## Supported Icon Packs

Now the following 19 icon packs are supported:
Now the following 20 icon packs are supported:

| Icon Pack | Prefix | License | Icon Numer |
| ------------------------------------------------------------- | ------ | ------------------------------------------------------------- | ---------- |
Expand All @@ -35,21 +35,22 @@ Now the following 19 icon packs are supported:
| [Heroicons](https://heroicons.com/) | `hi` | [MIT](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE) | 452 |
| [Ionicons](https://ionicons.com/) | `io` | [MIT](https://github.com/ionic-team/ionicons/blob/master/LICENSE) | 1332 |
| [Line Awesome](https://icons8.com/line-awesome) | `la` | [MIT](https://github.com/ionic-team/ionicons/blob/master/LICENSE) | 1544 |
| [Octicons](https://primer.style/octicons/) | `oi` | [MIT](https://github.com/primer/octicons/blob/master/LICENSE) | 209 |
| [Material Design icons](https://github.com/google/material-design-icons) | `md` | [Apache 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE) | 6911 |
| [Octicons](https://primer.style/octicons/) | `oi` | [MIT](https://github.com/primer/octicons/blob/master/LICENSE) | 219 |
| [Pokemon Icons](https://theartificial.github.io/pokemon-icons/) (Colorful)| `pi` | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) | 1453 |
| [PrimeIcons](https://github.com/primefaces/primeicons) | `pr` | [MIT](https://github.com/primefaces/primeicons/blob/master/LICENSE) | 202 |
| [Pixelarticons](https://pixelarticons.com/) | `px` | [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) | 460 |
| [Remix Icon](https://github.com/Remix-Design/RemixIcon) | `ri` | [Apache 2.0](https://github.com/Remix-Design/RemixIcon/blob/master/License) | 2271 |
| [Simple Icons](https://simpleicons.org/) | `si` | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1872 |
| [VSCode Icons](https://github.com/vscode-icons/vscode-icons) (Colorful) | `vi` | [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) | 1068 |
| [Simple Icons](https://simpleicons.org/) | `si` | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1882 |
| [VSCode Icons](https://github.com/vscode-icons/vscode-icons) (Colorful) | `vi` | [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) | 1072 |
| [Weather Icons](https://erikflowers.github.io/weather-icons/) | `wi` | [SIL OFL 1.1](http://scripts.sil.org/OFL) | 219 |


 

## Documentation

Search for icons and view the documentation [here](https://oh-vue-icons.vercel.app).
Search for icons and view the documentation [here](https://oh-vue-icons.netlify.app).


 
Expand Down Expand Up @@ -146,7 +147,7 @@ The icon names should be passed using **kebab-case**.

For [Font Awesome 5](https://fontawesome.com/) icons, icons from `regular` pack have name prop values like `fa-regular-flag`. Icons from `solid` and `brands` pack have name prop values like `fa-beer` and `fa-github`.

See the [documentation](https://oh-vue-icons.vercel.app/docs#basic-usage) for more about the usage.
See the [documentation](https://oh-vue-icons.netlify.app/docs#basic-usage) for more about the usage.


 
Expand All @@ -165,7 +166,7 @@ See the [documentation](https://oh-vue-icons.vercel.app/docs#basic-usage) for mo
| `title` | Icon title | `string` | / | / |
| `inverse` | Make icon color white? | `boolean` | `true` / `false` | `false` |

Some examples could be found in the [documentation](https://oh-vue-icons.vercel.app/docs#examples).
Some examples could be found in the [documentation](https://oh-vue-icons.netlify.app/docs#examples).


 
Expand Down Expand Up @@ -198,7 +199,7 @@ Contributions are welcomed, learn how to contribute [here](CONTRIBUTING.md).
## Acknowledgements

- This project is inspired by and based on [vue-awesome](https://github.com/Justineo/vue-awesome) and [react-icons](https://github.com/react-icons/react-icons).
- The [website](https://oh-vue-icons.vercel.app/) is hosted on [Vercel](https://vercel.com/).
- The [website](https://oh-vue-icons.netlify.app/) is hosted on [Netlify](https://www.netlify.com/).


 
Expand Down
2 changes: 1 addition & 1 deletion package/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"vue3",
"icons"
],
"homepage": "https://oh-vue-icons.vercel.app",
"homepage": "https://oh-vue-icons.netlify.app",
"bugs": {
"url": "https://github.com/Renovamen/oh-vue-icons/issues"
},
Expand Down

0 comments on commit 01b3172

Please sign in to comment.