Skip to content

Commit 4ebc429

Browse files
authored
style: example entry
style: example entry
2 parents 90e10e5 + 26e70f7 commit 4ebc429

File tree

4 files changed

+25
-17
lines changed

4 files changed

+25
-17
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ you can Run `pnpm test` or `pnpm test:ui` in VueHooks Plus's root folder.
3636

3737
## Running document
3838

39+
Start documentation via [Dev Document Guide](./DEV_DOCUMENT.md).
40+
3941
1. Run `pnpm docs:dev` in VueHooks Plus's root folder or Run `pnpm initial` and `pnpm docs:dev` `packages/hooks` folder.
4042

4143
2. `.md` must add a mapping path.

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,21 +109,23 @@ For other supported tools, please see [unplugin-auto-import](https://github.com/
109109
- [English Documentations](https://inhiblabcore.github.io/docs/hooks/en)
110110
- [中文文档](https://inhiblabcore.github.io/docs/hooks)
111111

112-
## 🕹️ Document Effects
112+
### Example
113113

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

116118
## 🪴 Project Activity
117119

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

120-
## 👛 Contributing
122+
### Contributing
121123

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

124-
## 🐝 Contributors
126+
### Contributors
125127

126-
Thanks for all their contributions!
128+
Thanks for all their contributions 🐝 !
127129

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

README.zh-CN.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,27 +109,29 @@ module.exports = {
109109
- [English Documentations](https://inhiblab-core.gitee.io/docs/hooks/en)
110110
- [中文文档](https://inhiblab-core.gitee.io/docs/hooks)
111111

112-
## 🕹️ 文档效果
112+
### 例子
113113

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

116-
# 🪴 项目活动
118+
## 🪴 项目活动
117119

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

120-
## 👛 贡献
122+
### 贡献
121123

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

124-
## 🐝 贡献者
126+
### 贡献者
125127

126-
感谢他们的所做的一切贡献!
128+
感谢他们的所做的一切贡献 🐝
127129

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

132-
# 🌸 感谢
134+
## 🌸 感谢
133135

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

packages/hooks/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,21 +109,23 @@ For other supported tools, please see [unplugin-auto-import](https://github.com/
109109
- [English Documentations](https://inhiblabcore.github.io/docs/hooks/en)
110110
- [中文文档](https://inhiblabcore.github.io/docs/hooks)
111111

112-
## 🕹️ Document Effects
112+
### Example
113113

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

116118
## 🪴 Project Activity
117119

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

120-
## 👛 Contributing
122+
### Contributing
121123

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

124-
## 🐝 Contributors
126+
### Contributors
125127

126-
Thanks for all their contributions!
128+
Thanks for all their contributions 🐝 !
127129

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

0 commit comments

Comments
 (0)