Skip to content

Commit 7fed450

Browse files
committed
docs: 完善说明文档
1 parent c568e1c commit 7fed450

File tree

4 files changed

+156
-58
lines changed

4 files changed

+156
-58
lines changed

LECENSE

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
MIT License
3+
4+
Copyright (c) Mikasa33 <https://github.com/mikasa33>
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

README.md

+24-57
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,44 @@
11
# Manga Wiki
22

3-
一个基于 [Bangumi API](https://github.com/bangumi/api/) 的漫画 Wiki 网站,同时支持 PC 和移动端。
3+
一个使用 [Nuxt](https://nuxt.com/) 开发的漫画 Wiki 网站,同时支持 PC 和移动端。
44

5-
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
6-
7-
## Setup
8-
9-
Make sure to install the dependencies:
5+
## Scripts
106

117
```bash
12-
# npm
13-
npm install
14-
15-
# pnpm
8+
# 安装
169
pnpm install
1710

18-
# yarn
19-
yarn install
20-
21-
# bun
22-
bun install
23-
```
24-
25-
## Development Server
26-
27-
Start the development server on `http://localhost:3000`:
28-
29-
```bash
30-
# npm
31-
npm run dev
32-
33-
# pnpm
34-
pnpm run dev
11+
# 启动
12+
pnpm dev
3513

36-
# yarn
37-
yarn dev
14+
# 构建
15+
pnpm build
3816

39-
# bun
40-
bun run dev
17+
# 预览
18+
pnpm preview
4119
```
4220

43-
## Production
44-
45-
Build the application for production:
46-
47-
```bash
48-
# npm
49-
npm run build
21+
## Thanks
5022

51-
# pnpm
52-
pnpm run build
23+
- [bangumi/api](https://github.com/bangumi/api/)
5324

54-
# yarn
55-
yarn build
25+
## License
5626

57-
# bun
58-
bun run build
59-
```
27+
<!-- automd:contributors author="Mikasa33" license="MIT" -->
6028

61-
Locally preview production build:
29+
Published under the [MIT](https://github.com/Mikasa33/manga-wiki/blob/main/LICENSE) license.
30+
Made by [@Mikasa33](https://github.com/Mikasa33) and [community](https://github.com/Mikasa33/manga-wiki/graphs/contributors) 💛
31+
<br><br>
32+
<a href="https://github.com/Mikasa33/manga-wiki/graphs/contributors">
33+
<img src="https://contrib.rocks/image?repo=Mikasa33/manga-wiki" />
34+
</a>
6235

63-
```bash
64-
# npm
65-
npm run preview
36+
<!-- /automd -->
6637

67-
# pnpm
68-
pnpm run preview
38+
<!-- automd:with-automd -->
6939

70-
# yarn
71-
yarn preview
40+
---
7241

73-
# bun
74-
bun run preview
75-
```
42+
_🤖 auto updated with [automd](https://automd.unjs.io)_
7643

77-
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
44+
<!-- /automd -->

package.json

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
{
22
"name": "manga-wiki",
33
"type": "module",
4-
"version": "0.1.0",
4+
"version": "0.2.0",
55
"private": true,
6+
"author": "Mikasa33 <[email protected]>",
7+
"homepage": "https://github.com/Mikasa33/manga-wiki#readme",
8+
"repository": {
9+
"type": "git",
10+
"url": "git+https://github.com/Mikasa33/manga-wiki.git"
11+
},
12+
"bugs": "https://github.com/Mikasa33/manga-wiki/issues",
613
"scripts": {
714
"build": "nuxt build",
815
"dev": "nuxt dev",
@@ -31,6 +38,7 @@
3138
"@iconify-json/icon-park-outline": "^1.2.1",
3239
"@nuxt/eslint": "^0.6.0",
3340
"@vueuse/nuxt": "^11.1.0",
41+
"automd": "^0.3.12",
3442
"eslint": "^9.12.0",
3543
"eslint-plugin-format": "^0.1.2",
3644
"tailwindcss": "^3.4.14",

pnpm-lock.yaml

+101
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)