mirror of https://github.com/PaiGramTeam/PaiGramDocs.git synced 2024-11-22 07:07:47 +00:00

The documentation of PaiGram, used to record usage and development guidelines.

Go to file

Nahida 381518db63 📝 Rename to @NahidaBuer		2023-12-05 04:29:21 +08:00
.github/workflows	Update actions/checkout action to v4	2023-10-21 14:12:59 +08:00
docs	📝 Rename to @NahidaBuer	2023-12-05 04:29:21 +08:00
scripts	📝 Add quick-start	2023-10-21 13:28:21 +08:00
.eslintignore	📝 Add quick-start env	2023-10-21 01:15:41 +08:00
.eslintrc.cjs	📝 Add quick-start env	2023-10-21 01:15:41 +08:00
.gitignore	👷 Add Azure Static Web Apps workflow file	2023-10-21 13:50:02 +08:00
LICENSE	♻️ refact using vitepress	2023-10-20 22:46:10 +08:00
package-lock.json	Update dependency @iconify/json to v2.2.132	2023-10-24 17:56:40 +08:00
package.json	Update dependency vitepress to v1.0.0-rc.24	2023-10-24 15:03:24 +08:00
pnpm-lock.yaml	Update dependency vitepress to v1.0.0-rc.24	2023-10-24 15:03:24 +08:00
README.md	🐛 Fix search	2023-10-24 20:27:37 +08:00
tsconfig.json	📝 Add quick-start env	2023-10-21 01:15:41 +08:00
unocss.config.ts	📝 Add quick-start env	2023-10-21 01:15:41 +08:00
vite.config.ts.js	📝 Add quick-start env	2023-10-21 01:15:41 +08:00

PaimonDocs

这里是 PaiGram 的说明文档，用来记录使用方法和开发指南。

欢迎在 Issues 中提出文档需求，或直接向本仓库提交文档。

Initialize the project locally

Environment requirements:

If your Node.js version is lower than 16.13.0，Please install corepack first.
npm install -g corepack

corepack enable
corepack prepare pnpm@latest --activate

git clone https://github.com/PaiGramTeam/PaiGramDocs.git
cd PaiGramDocs

pnpm install

pnpm dev

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

pnpm dev Starts the development server.

pnpm build Bundles your website into static files for production.

pnpm serve Serves the built website locally.