qian奇岸微信二维码 如您需要快速报价 请加技术经理微信 服务热线
13501992972
"MENU"
首页 > 行业新闻 > 正文

序言许多人期待有着自己的文档系统软件来纪录/汇总他所所学的知

奇岸开发
ahqian.com
10/22/2022
wechat

无需加好友免费技术支持

序言

许多人期待有着自己的文档系统软件来纪录/汇总他所所学的知识。

文中介绍一下 Docsify[1] Github Page 致力于迅速搭建自已的文档网址

文中的 Demo 编码能通过 Github[2] 查看,在这儿演示[3]

前期准备工作

全局性组装 docsify-cli 建立文档项目目录

复位新项目

完成后也会产生一个 docs 文件夹,里边有三个文件

index.html 通道文件。我们自己的很多配置就在这里配置README.md 将成为首页具体内容3D渲染.nojekyll 用以阻拦 GitHub Pages 忽视下横线开头文件启动项目

根据运作 docsify serve 当地服务器启动便捷实时预览实际效果。默认设置访问地址 。以下几点期为 README.md 里面的内容

简单配置

下一步是配置我们自己的文档

配置侧栏

在 index.html 中、新配置 loadSidebar: true

在 docs 中新创建文件 _sidebar.md,载入

另外在 docs 中新创建 closure.md 、prototype.md和 layout.md三个 Markdown 文件

还可以在 closure.md 写如下所示,查看实际效果

目录自动生成

文件目录也可以根据文章标题形成,这一点在文章内容长期内非常有利。配置和质量能直接演示

插件的应用

基本上配置已完成,除此之外还有别的更多作用配置,这里不细说了。Docsify 还提供丰富多样的插件,一起来看看

全文检索

配置非常简单

查看实际效果

图片放大

Docsify 图片放大必须插件,但很简单,如下所示

适用 CodePen 插进

随意找一个 CodePen,开启,寻找 Embed,点击查看

image.png

点一下 iframe,copy 里边的编码。黏贴到自己的 markdown 文件中

就能查看 CodePen 的啦

更多插件实现方案

Docsify 还提供 Gitalk[5] 评价插件等。客户程序官方网文件[6],这里就不多说了。

布署

大家立即布署到你不用网络服务器(自然) Github Page 正中间。首先把我们自己的编码上传至 Github。这儿不会再演示这一步,请阅读者自身进行

寻找 Settings

寻找 GitHub Pages,挑选 main 和 docs 点一下文件夹 save

等一会儿,我们自己的文档详细地址便会形成,点击这里[7]查看文中的演示实际效果

汇总

文中从 0 到 1 详细介绍以 Docsify[8] Github Page迅速搭建自已的文档系统软件并线上布署。自然,文章内容只提及了 Docsify 对作用的一小部分有兴趣,能去官方网[9]查看

参考文献

[1]Docsify:

[2]Github:

[3]这儿:

[4

[5]Gitalk:

[6]官方网文件:

[7]这儿:

[8]Docsify:

[9]官方网:

热度442

了解更多序言许多人期待有着自己的文档系统软件来纪录/汇总他所所学的知欢迎联系奇岸开发客服。

奇岸开发可定制企业官网小程序、小程序商城、餐饮外卖小程序、预约小程序、多门店小程序、分销小程序及个人小程序。

微信二维码

微信长按识别或扫一扫,无需加好友直接咨询,企业网站开发、网站托管维护、企业管理系统开发、微信小程序制作、域名主机、网站备案、网站改版等提供专业技术解答。

精彩推荐

猜你喜欢