Skip to content

Commit 14c3fe3

Browse files
committed
docs: add branded README
1 parent 825e4b6 commit 14c3fe3

File tree

2 files changed

+21
-44
lines changed

2 files changed

+21
-44
lines changed

Diff for: .vscode/settings.json

+6
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@
4848
"postcss"
4949
],
5050

51+
// Markdownlint
52+
"markdownlint.config": {
53+
"first-line-h1": false,
54+
"no-inline-html": false
55+
},
56+
5157
// Use the workspace version of TypeScript
5258
"typescript.tsdk": "node_modules/typescript/lib"
5359
}

Diff for: README.md

+15-44
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,46 @@
1-
# Nuxt 3 Minimal Starter
1+
<p align="center">
2+
<img src="public/icon.svg" alt="NPC Logo" align="center" width="128" height="128">
3+
</p>
24

3-
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
5+
<h1 align="center">Website</h1>
6+
7+
<p align="center">The front page of NPC: Crafted with Nuxt, powered by passion</p>
8+
9+
<p align="center">
10+
<a href="https://ntut.club">
11+
<img
12+
alt="An NPC Project"
13+
src="https://img.shields.io/badge/An_NPC_Project-black?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzMiAzMiIgZmlsbD0iI2ZmZiI%2BPHBhdGggZD0iTTQgNHYyNGw4LTggMTYgOFY0bC04IDh6Ii8%2BPC9zdmc%2B"
14+
>
15+
</a>
16+
</p>
417

518
## Setup
619

720
Make sure to install the dependencies:
821

922
```bash
10-
# npm
11-
npm install
12-
13-
# pnpm
1423
pnpm install
15-
16-
# yarn
17-
yarn install
18-
19-
# bun
20-
bun install
2124
```
2225

2326
## Development Server
2427

2528
Start the development server on `http://localhost:3000`:
2629

2730
```bash
28-
# npm
29-
npm run dev
30-
31-
# pnpm
3231
pnpm run dev
33-
34-
# yarn
35-
yarn dev
36-
37-
# bun
38-
bun run dev
3932
```
4033

4134
## Production
4235

4336
Build the application for production:
4437

4538
```bash
46-
# npm
47-
npm run build
48-
49-
# pnpm
5039
pnpm run build
51-
52-
# yarn
53-
yarn build
54-
55-
# bun
56-
bun run build
5740
```
5841

5942
Locally preview production build:
6043

6144
```bash
62-
# npm
63-
npm run preview
64-
65-
# pnpm
6645
pnpm run preview
67-
68-
# yarn
69-
yarn preview
70-
71-
# bun
72-
bun run preview
7346
```
74-
75-
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

0 commit comments

Comments
 (0)