Skip to content

官网/文档中心部署

项目的官网和文档中心是基于 VitePress 构建的静态网站。

本地开发

  1. 进入目录:

    bash
    cd website
  2. 安装依赖:

    bash
    npm install
  3. 启动开发服务器:

    bash
    npm run docs:dev

    访问 http://localhost:5173 即可预览效果。

生产环境部署

1. 编译静态文件

在部署之前,需要将 Markdown 源码编译为静态 HTML:

bash
npm run docs:build

编译完成后,产物将生成在 website/.vitepress/dist 目录下。

2. 托管方式

由于产物是纯静态文件,您可以选择以下任一方式进行托管:

方案 A:Nginx 托管 (推荐)

如果您使用自己的服务器,配置示例:

nginx
server {
    listen 80;
    server_name your-docs-domain.com;

    location / {
        root /path/to/Dynamic_Domain/website/.vitepress/dist;
        index index.html;
        # 支持 VitePress 的简洁 URL
        try_files $uri $uri.html $uri/ =404;
    }
}

方案 B:静态托管平台

您可以利用以下平台实现自动部署:

  • GitHub Pages: 将代码推送到 GitHub,在 Settings -> Pages 中配置使用 GitHub Actions。
  • Vercel / Netlify: 关联仓库后,设置构建命令为 npm run docs:build,输出目录设为 website/.vitepress/dist

注意事项

  • Node.js 版本: 建议使用 Node.js 18.x 或更高版本。
  • 静态资源: 所有的公共资源(如 logo、二维码图片)应放置在 website/public 目录下。

基于 MIT 许可发布