如何使用docsify搭建自己的github文档?
安装前提
确认电脑已经安装好 node
和 npm
环境。 如果还没有装好,那需要执行下面的步骤:
1.进入官网:https://nodejs.org/zh-cn/ , 下载长期支持版。
3.直到finish,打开cmd命令行,查看环境变量以及版本。(此时你们看到的应该还是只把node.js的根目录添加到环境变量path)
4.运行命令修改npm的文件夹前缀和缓存目录,配置镜像站。
然后使用npm config list
就可以看到自己的配置:
还需要增加一个环境变量,是node的modules的环境变量(我的nodejs在D盘根目录下,你们的要自己根据实际情况):
5.然后如果使用npm
安装了东西,但是找不到该命令,则还需要在Path中,把我们node的全局文件夹添加进去环境变量中。
这样我们就可以愉快的安装东西了。
docsify走起
废话我就不多说了,直接安装docsify-cli
:
然后我们建立一个测试文件夹叫note
,命令行进入这个文件夹:
就成功了!!!看到它叫你执行命令,本地启动一下:
这样就可以在本地http://localhost:3000打开了,神奇~(修改内容后保存就可以,不需要重新启动)
美化一下
说实在话,挺丑的,那就美化一下:
先加一个封面,需要在`index.html中,把下面的属性设置为true
然后新建一个文件_coverpage.md
:
我们还需要一个侧边栏,再将侧边栏属性打开:
然后新建一个侧边栏的文件_sidebar.md
:
其中中间那部分使用的是README.md
的内容,其他的index.html的内容如下(自己根据需要设置,如果有更高级的需求,建议去官网查文档!!!)
如何部署到github
下面讲讲如何部署,首先我们需要有一个远程的仓库,我默认你有了,使用命令初始化文件夹,关联远程仓库
push
代码到远程仓库就可以了,git
的操作就不仔细讲了,或者自己把远程的仓库先clone
下来,再用docsify
创建文档,然后提交,也是ok的。
提交上去之后,我们需要做一个操作,在settings
下有一个GitHub Pages
,选择构建分支和文件目录即可。我使用的是master
,根目录的docs
文件夹。然后你就可以看到已经发布成功了,直接访问网址就可以。
PS:项目是我的其他项目地址,但是流程是一致的。
坑点
我打不开网址!!!是因为电信会屏蔽一些网站,也就是被qiang了,懂的都懂,如果要访问的话,可以修改DNS,或者搞一把梯_子。
【作者简介】:
秦怀,公众号【秦怀杂货店】作者,技术之路不在一时,山高水长,纵使缓慢,驰而不息。这个世界希望一切都很快,更快,但是我希望自己能走好每一步,写好每一篇文章,期待和你们一起交流。
此文章仅代表自己(本菜鸟)学习积累记录,或者学习笔记,如有侵权,请联系作者核实删除。人无完人,文章也一样,文笔稚嫩,在下不才,勿喷,如果有错误之处,还望指出,感激不尽~
__EOF__

本文链接:https://www.cnblogs.com/Damaer/p/14311154.html
关于博主:评论和私信会在第一时间回复。或者直接私信我。
版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!
声援博主:如果您觉得文章对您有帮助,可以点击文章右下角【推荐】一下。您的鼓励是博主的最大动力!
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· PostgreSQL 和 SQL Server 在统计信息维护中的关键差异
· C++代码改造为UTF-8编码问题的总结
· DeepSeek 解答了困扰我五年的技术问题
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· 清华大学推出第四讲使用 DeepSeek + DeepResearch 让科研像聊天一样简单!
· 实操Deepseek接入个人知识库
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库