code-nav-doc

编程导航文档

在线访问

编程导航项目的使用指南和详细介绍。

项目展示

主页

快速开始

请保证 Node.js 版本 > 10 ⚠️

1. 下载项目到本地

   git clone https://github.com/liyupi/code-nav.git

2. 进入目录，安装依赖

   cd code-nav-doc
   npm install

3. 本地启动项目

   npm run start

4. 打包构建

   npm run docs:build

   会生成 docs-dist 目录，可以通过 serve 工具 本地启动 server 快速浏览。

5. 部署

   利用腾讯云静态站点托管：可以直接将 docs-dist 目录发布到 静态站点托管 中，有 CDN 支持

   tcb hosting deploy . -e envId

技术选型

前端

基于 dumi 文档生成工具

后端

1. 腾讯云云存储 存放图片，CDN 加速
2. Vercel 部署静态文档网站