尧图建网站 尧图建网站 YAOTU WEB BUILD 免费咨询
ARTICLE DETAIL

资讯详情

深耕网站建设与建站编程的一线实战洞察。

利用VitePress快速生成技术文档站点或博客

利用VitePress快速生成技术文档站点或博客 最近一直在做cesium相关的开发我将cesium封装成了一个可以快速实现业务的组件避免cesium繁琐的api方法调用。后续我会上线相关的技术文档这次介绍如何快速搭建一个技术文档。文档上线啦https://banyan666.github.io/BMapViewer/docs/搭建文档我力推VitePress这个库使用这个库只需要写Markdown文件即可非常好用并且现在AI普及直接交给AI帮你去生成Markdown文件非常效率。VitePress地址https://vitepress.dev/zh/guide/what-is-vitepress注意使用这个库需要node.js版本大于20其实根据官方文档按照步骤执行命令即可以及很详细了我这里简化一下。第一步先创建一个文件夹然后cmd打开终端执行以下命令。pnpm add -D vitepressnext第二步然后终端继续执行以下命令第一个填写docs然后就一路回车即可。pnpm vitepress init第三步终端执行运行命令即可运行文档。npm run docs:dev看到这个就说明你的文档以及搭建好了你只需要去编写md文档每个md文档打包后就是一个静态的html页面。第四步在docs目录下新增你的md文档编写你对应的技术文档交给AI帮你生成md真的非常方便你只需要最后核对一下文档是否写的正确微调即可。第五步写完你的文档后执行以下命令打包。npm run docs:build打包结束在.vitepress目录下会生成一个dist文件这就是打包后的文件和vue项目一样直接将这个文件扔到服务器上部署就能有你自己的技术文档了。
返回列表