VitePress Template - 1224HuangJin ​

一个基于 wyf9/vitepress-template 二次修改的 VitePress 文档网站模板。

This is a modified version of wyf9/vitepress-template.

Preview 预览： ​

1224huangjin-vitepress-template.pages.dev

☁️ Cloudflare Pages 部署 / Deployment ​

你可以使用 Cloudflare Pages 部署本项目。

You can deploy this project using Cloudflare Pages.

📖 原版 README / Original README ​

注意 / Notice

以下内容为 wyf9/vitepress-template 的原始 README，仅用于参考。

The following content is the original README from wyf9/vitepress-template and is provided for reference only.

其内容不代表本仓库的许可证（LICENSE）、版权声明或其他相关内容。

It does not represent the license, copyright, or other contents of this repository.

For self-use mainly.

Preview: vitepress-template.wyf9.top

Quick Start ​

Use this template

pnpm install
pnpm update # Must do update before use

Customize ​

Delete these files:

rm api-examples.md
rm markdown-examples.md
rm en_us/api-examples.md
rm en_us/markdown-examples.md

Then edit these files:

.vitepress/config.mts
index.md
en_us/index.md
README.md

GitHub Pages Deployment ​

If you need GitHub Pages deployment, go to:

Settings → Pages → Source → GitHub Actions

Then enable the Deploy VitePress site to Pages workflow.

If you don't need GitHub Pages deployment, simply remove:

.github/workflows/deploy.yml

Commands ​

pnpm dev      # Start the development server
pnpm build    # Build the site (.vitepress/dist/)
pnpm preview  # Preview the built site

Credits ​

The original template is released under the Unlicense.