Skip to content

Commit

Permalink
style: example entry
Browse files Browse the repository at this point in the history
style: example entry
  • Loading branch information
inhiblab authored Jan 27, 2023
2 parents 90e10e5 + 26e70f7 commit 4ebc429
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 17 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ you can Run `pnpm test` or `pnpm test:ui` in VueHooks Plus's root folder.

## Running document

Start documentation via [Dev Document Guide](./DEV_DOCUMENT.md).

1. Run `pnpm docs:dev` in VueHooks Plus's root folder or Run `pnpm initial` and `pnpm docs:dev` `packages/hooks` folder.

2. `.md` must add a mapping path.
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,21 +109,23 @@ For other supported tools, please see [unplugin-auto-import](https://github.com/
- [English Documentations](https://inhiblabcore.github.io/docs/hooks/en)
- [中文文档](https://inhiblabcore.github.io/docs/hooks)

## 🕹️ Document Effects
### Example

Start documentation via [Dev Document Guide](./DEV_DOCUMENT.md).
- [Nuxt3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/nuxt3)
- [Vite + Vue3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/vite-vue3)
- [Webpack + Vue3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/webpack-vue3)

## 🪴 Project Activity

![Alt](https://repobeats.axiom.co/api/embed/35dbca2274542c0144993be92cc51762227543d9.svg 'Repobeats analytics image')

## 👛 Contributing
### Contributing

Welcome to join us! You can check out the [Contributing Guide](./CONTRIBUTING.md) to learn how to get started.

## 🐝 Contributors
### Contributors

Thanks for all their contributions!
Thanks for all their contributions 🐝 !

<a href="https://github.com/InhiblabCore/vue-hooks-plus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=InhiblabCore/vue-hooks-plus" />
Expand Down
16 changes: 9 additions & 7 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,27 +109,29 @@ module.exports = {
- [English Documentations](https://inhiblab-core.gitee.io/docs/hooks/en)
- [中文文档](https://inhiblab-core.gitee.io/docs/hooks)

## 🕹️ 文档效果
### 例子

通过 [Dev Document Guide](./DEV_DOCUMENT.md) 启动文档。
- [Nuxt3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/nuxt3)
- [Vite + Vue3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/vite-vue3)
- [Webpack + Vue3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/webpack-vue3)

# 🪴 项目活动
## 🪴 项目活动

![Alt](https://repobeats.axiom.co/api/embed/35dbca2274542c0144993be92cc51762227543d9.svg 'Repobeats analytics image')

## 👛 贡献
### 贡献

欢迎你的加入!你可以查阅 [贡献指南](./CONTRIBUTING.md) 了解如何开始。

## 🐝 贡献者
### 贡献者

感谢他们的所做的一切贡献!
感谢他们的所做的一切贡献 🐝

<a href="https://github.com/InhiblabCore/vue-hooks-plus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=InhiblabCore/vue-hooks-plus" />
</a>

# 🌸 感谢
## 🌸 感谢

这个项目的灵感主要来自于以下这些很棒的项目。

Expand Down
12 changes: 7 additions & 5 deletions packages/hooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,21 +109,23 @@ For other supported tools, please see [unplugin-auto-import](https://github.com/
- [English Documentations](https://inhiblabcore.github.io/docs/hooks/en)
- [中文文档](https://inhiblabcore.github.io/docs/hooks)

## 🕹️ Document Effects
### Example

Start documentation via [Dev Document Guide](./DEV_DOCUMENT.md).
- [Nuxt3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/nuxt3)
- [Vite + Vue3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/vite-vue3)
- [Webpack + Vue3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/webpack-vue3)

## 🪴 Project Activity

![Alt](https://repobeats.axiom.co/api/embed/35dbca2274542c0144993be92cc51762227543d9.svg 'Repobeats analytics image')

## 👛 Contributing
### Contributing

Welcome to join us! You can check out the [Contributing Guide](./CONTRIBUTING.md) to learn how to get started.

## 🐝 Contributors
### Contributors

Thanks for all their contributions!
Thanks for all their contributions 🐝 !

<a href="https://github.com/InhiblabCore/vue-hooks-plus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=InhiblabCore/vue-hooks-plus" />
Expand Down

0 comments on commit 4ebc429

Please sign in to comment.