给自己的项目发布一个文档吧
1|0给自己的项目发布一个文档
1|1Github Page配置
在上一篇,我们搭建了一个脚手架,方便我们更快的开始一个项目。这篇我们将使用github page给这个项目发布一个文档
我们可以在 github 仓库的 Setting-Pages界面进行文档的设置,例如我这个仓库,把文档源设置成了当前仓库master分支的/docs目录,之后我们只需要往这个目录下添加静态文件就可以在对应的site展示文档了。
1|2使用Docsify
使用Docsify能更方便地发布文档,只需要编辑md文件即可修改页面信息,因此我们使用docsify来构建文档
安装
首先你需要安装node.js,这里就不细说了
然后npm i docsify-cli -g
全局安装docsify-cli工具
docsify init ./docs
初始化文档,我们设置的github page源是docs目录,所以初始化的是docs目录
初始化成功后会看到docs目录下会有几个文件
index.html
入口文件README.md
会做为主页内容渲染.nojekyll
用于阻止 GitHub Pages 忽略掉下划线开头的文件
直接编辑README.me 就能更新文档内容了
本地查看
docsify serve docs
即可在本地查看页面
配置
另外如果要对页面进行详细配置可以看官方文档和这篇文章,docsify,Docsify使用指南(打造最快捷、最轻量级的个人&团队文档) - 追逐时光者 - 博客园 (cnblogs.com)。
这里是我的配置文件以及最终效果
配置文件:https://github.com/weloe/go-web-demo/tree/master/docs
index.html
最终效果
https://weloe.github.io/go-web-demo/#/
发布
当你配置完文件,直接push到github上时就会自动发布,前提是你按照文章开头设置了page
成功发布完后能在仓库的commit记录和仓库的Environments看到这两个
__EOF__

本文链接:https://www.cnblogs.com/weloe/p/17374287.html
关于博主:评论和私信会在第一时间回复。或者直接私信我。
版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!
声援博主:如果您觉得文章对您有帮助,可以点击文章右下角【推荐】一下。您的鼓励是博主的最大动力!
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 【.NET】调用本地 Deepseek 模型
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· DeepSeek “源神”启动!「GitHub 热点速览」
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库
· 我与微信审核的“相爱相杀”看个人小程序副业