前言
很多同学都希望能够拥有自己的一个文档系统,去记录/总结自己所学到的知识 。
本文就来介绍一下 Docsify[1] + Github Page 的方式,旨在快速搭建属于自己的文档网站
本文的 Demo 代码可以通过 Github[2] 查看 , 演示看这里[3]
准备工作
全局安装 docsify-cli 工具,并创建文档项目目录
npm i docsify-cli -gmkdir my-docscd my-docs复制代码
初始化项目
docsify init ./docs复制代码
成功后会生成一个 docs 的文件夹,并且里面有三个文件
- index.html 入口文件 。后面我们的配置很多都是在这里配置
- README.md 会做为主页内容渲染
- .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件
docsify serve docs复制代码
通过运行 docsify serve 启动一个本地服务器,可以方便地实时预览效果 。默认访问地址 http://localhost:3000%5B4%5D。下面的内容时间上是 README.md 中的内容文章插图
简单的配置
接下来就是配置我们的文档了
配置侧边栏
在 index.html 中,新增配置 loadSidebar: true
window.$docsify = {name: '',repo: '',+loadSidebar: true}复制代码
在 docs 中新建一个文件 _sidebar.md , 写入- JavaScript- [闭包](closure.md "闭包")- [原型](prototype.md "原型")- CSS- [布局](layout.md "布局")复制代码
同时在 docs 中新建 closure.md 、prototype.md和 layout.md三个 Markdown 文件可以在 closure.md 中写入如下,查看效果
# 介绍闭包## 什么是闭包哈哈哈哈## 闭包的作用是什么复制代码
文章插图
自动生成目录
可以根据标题生成目录,这个在文章很长的时候很有用,直接演示配置和效果
window.$docsify = {name: '',repo: '',loadSidebar: true,+ subMaxLevel: 2}复制代码
文章插图
插件的使用
基础的配置已经完成了 , 当然还有其他更多的功能配置,这里不再细说 。Docsify 还提供了丰富的插件,接下来我们看看
全文搜索
配置非常简单
<script>window.$docsify = {name: '',repo: '',loadSidebar: true,subMaxLevel: 2,+search: 'auto'}</script><!-- Docsify v4 --><script src="http://www.wokk.cn//cdn.jsdelivr.net/npm/docsify@4"></script>+<script src="http://www.wokk.cn//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>复制代码
查看效果文章插图
图片缩放
Docsify 是需要插件才能实现图片缩放的,但其实也很简单,如下
<script>window.$docsify = {name: '',repo: '',loadSidebar: true,subMaxLevel: 2,search: 'auto'}</script><!-- Docsify v4 --><script src="http://www.wokk.cn//cdn.jsdelivr.net/npm/docsify@4"></script><script src="http://www.wokk.cn//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>+<script src="http://www.wokk.cn//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>复制代码
支持 CodePen 插入随便找到一个 CodePen , 打开,找到 Embed , 点击进入
文章插图
image.png
点击 iframe,copy 里面的代码 。粘贴到你的 markdown 文件中
以上关于本文的内容,仅作参考!温馨提示:如遇健康、疾病相关的问题,请您及时就医或请专业人士给予相关指导!
「四川龙网」www.sichuanlong.com小编还为您精选了以下内容,希望对您有所帮助:- 问道手游仙魔录全部任务 问道仙魔录任务流程及攻略
- 教你重装系统步骤详解 重做win10系统步骤流程
- 桃花岛奇遇入门流程 九阴真经桃花岛奇遇方法
- 用html制作个人网页教学 个人主页网页设计代码
- 教你恢复数据的方法流程 聊天记录怎么恢复找回来
- 用html制作个人介绍页面 学生html静态网页模板
- 网页设计与网站开发 正规网站建设制作流程
- 隐藏小箭头的方法流程 怎么清除桌面图标角标
- 建立网站的流程分享 如何开发属于自己的网站
- 魔兽世界风剑任务流程及地图 风剑任务流程位置