在此之前,写手册是一件令程序员很费心的事,但现在有了VitePress,一切都是那么简单。
首先,安装VitePress:
cnpm install -g vitepress |
在此之前,您应查看我的有关于 cnpm 的文章。
然后,找到一个文件夹,输入
npm init |
会让你输入一些信息,输入即可。
然后,需要在生成的package.json内写一些东西(这时文件夹应该只有一个package.json)
// package.json的内容 |
这一段要替换已有的script字段。
随后,新建一个 index.md,内容随便。
然后,在package.json
所在的目录里运行
npm run dev |
这是会提示已经部署在了http://localhost:3000/,去看看,手册是不是跑起来了?
现实的应该是你写的md内容,是不是有点小鸡冻?
接下来,咱再添加一些页面。
在VitePress中,添加页面 == 添加Markdown文件。
例如目录中有一个 index.md 、 一个 1.md,你就可以用localhost:3000 访问 index.md,用 localhost:3000/1 来访问 1.md。
VitePress的目录路由根据是这样的:
/
代表根(这里的根是指package.json
文件所在的文件夹,以下皆同)文件夹的 index.md,/docs
代表根目录下的docs文件夹里的 index.md,而如果你有链接通往/docs文件夹,而你没有创建,VitePress会寻找根目录下的 docs.md,如果还是没有,才会爆404。
并且,如果你同时有docs.md和docs文件夹,你连接到/docs会自动连接到 /docs.md,而/docs/才会连接到docs文件夹。
然后,你可以添加侧边栏与导航栏。
在根目录新建一个名为.vitepress
的文件夹,在里面放一个名为 config.js
的文件,文件中写上
module.exports = { |
这个中的item、children等属性就用于设置侧边栏。link、text则分别控制连接的链接和文字。
然后,你如果构建html文件,使用
npm run build |
即可。
生成的文件在/.vitepress/dist/文件夹中。
这种方法的优势是不会创建node-module文件夹,使你的项目文件可以轻松存储在便携式存储设备如云盘、GitHub、U盘等设备中。
- 本文链接:https://blog.adkimsm.asia/post/77784881e3e6/
- 版权声明:本博客所有文章除特别声明外,均默认采用 许可协议。