最近又要写技术文档了,查看了一下市面上的一些文档生成器,如

docsify

http://vuepress.com/、

Vite & Vue Powered Static Site Generator


综合比较还是比较倾向vitepress,vuepress之前用过界面不是很直接,docsify界面布局也不是很理想。vitepress不叫好看的主题就是vite的官网了。



怎样基于VitePress(Vite官网主题)写自己文档_github


是不是简洁,还带着一些小清新?



怎样基于VitePress(Vite官网主题)写自己文档_生成器_02


二级标题和三级标题更直接明了。

所以打算白嫖vite网站了。

1.找到开源地址

地址:https://github.com/vitejs/vite (英文版实时最新的)



怎样基于VitePress(Vite官网主题)写自己文档_源地址_03


地址:https://github.com/vitejs/docs-cn (中文版有有时间延迟)

2.git pull代码

3.修改里面额MD文档形成自己的

4.怎样杜绝原有赞助广告?

查看network,可以查看到对应的广告文件请求



怎样基于VitePress(Vite官网主题)写自己文档_生成器_04




怎样基于VitePress(Vite官网主题)写自己文档_源地址_05


上面的json就是对应的广告数据



怎样基于VitePress(Vite官网主题)写自己文档_源地址_06




怎样基于VitePress(Vite官网主题)写自己文档_生成器_07


找到对应文件,请求去掉,注释data



怎样基于VitePress(Vite官网主题)写自己文档_源地址_08


5.全文搜索

此处的搜索是用的algolia的docsearch组件,需要algolia注册账号,并获取对应的key,创建database,和index



怎样基于VitePress(Vite官网主题)写自己文档_源地址_09




怎样基于VitePress(Vite官网主题)写自己文档_生成器_10




怎样基于VitePress(Vite官网主题)写自己文档_github_11


这样你就拥有一个md文档生成器了