docsify 使用说明
Docsify 使用说明
此处仅做简略说明,如需详细了解请参考docsify官网
推荐全局安装 docsify-cli
工具,可以方便地创建及在本地预览生成的文档。
npm i docsify-cli -g
初始化项目
如果想在项目的 ./docs
目录里写文档,直接通过 init
初始化项目。
docsify init ./docs
开始写文档
初始化成功后,可以看到 ./docs
目录下创建的几个文件
index.html
入口文件README.md
会做为主页内容渲染.nojekyll
用于阻止 GitHub Pages 忽略掉下划线开头的文件
直接编辑 docs/README.md
就能更新文档内容,当然也可以添加更多页面。
本地预览
通过运行 docsify serve
启动一个本地服务器,可以方便地实时预览效果。默认访问地址 http://localhost:3000 。
docsify serve docs
说明:在文件根目录,通过运行
docsify serve
启动一个本地服务器,即:在docs根目录下执行docsify serve
即可,如果在docs上级目录,可示例方式执行docsify serve docs
启动本地服务器
关于文档书写
markdown文档书写工具,使用自己熟悉的工具即可,例如Typora
如果变更导航栏,则需要修改_navbar.md
如果变更侧边栏,则需要修改_sidebar.md,根据具体业务修改相关文件夹下的侧边栏文件即可
多页文档
如果需要创建多个页面,或者需要多级路由的网站,在 docsify 里也能很容易的实现。例如创建一个 guide.md
文件,那么对应的路由就是 /#/guide
。
假设你的目录结构如下:
.
└── docs├── README.md├── guide.md└── zh-cn├── README.md└── guide.md
那么对应的访问页面将是:
docs/README.md => http://domain.com
docs/guide.md => http://domain.com/guide
docs/zh-cn/README.md => http://domain.com/zh-cn/
docs/zh-cn/guide.md => http://domain.com/zh-cn/guide
重点文件说明
index.html:该文件内容最好不要修改,如需要修改请参考docsify官网修改相关配置
_sidebar.md:为侧边栏目录文件
_navbar.md:为导航栏目录文件
说明:创建 .nojekyll
命名的空文件,阻止 GitHub Pages 忽略命名是下划线开头的文件。
线上部署
nginx新增一下配置即可:
server {listen 4006;server_name localhost;location / {alias /opt/source/docs/; index index.html;}}
history路由调整侧边栏
routerMode: 'history',
alias: {'/.*/_sidebar.md': function (_sidebar) {var basePath = _sidebar.match(/\/.*?\//)[0];var sideValue = basePath + '_sidebar.md';return sideValue;},
},
忽略编译链接
有时候我们会把其他一些相对路径放到链接上,你必须告诉 docsify 你不需要编译这个链接。 例如:
[link](/demo/ ':ignore')
即将会得到 <a href="/demo/">link</a> html
代码。不要担心,你仍然可以为链接设置标题。
如果链接为附件下载链接,也可使用此方式
[link](/demo/ ':ignore title')<a href="/demo/" title="title">link</a>
docsify 使用说明相关推荐
- Docsify个人网站搭建详细教程
目录 一.什么是 docsify 二.安装 docsify 三.多页文档设置 四.定制化配置 4.1.侧边栏 4.2.导航栏 4.3.封面 4.4.主题 五.部署 5.1.部署到Gitee 5.2.部 ...
- abaqus高性能服务器怎么用,高性能计算平台ABAQUS任务调度使用说明作者陈林E-Mailchenlin.PDF...
高性能计算平台ABAQUS任务调度使用说明作者陈林E-Mailchenlin.PDF 高性能计算平台ABAQUS 任务调度使用说明 作者:陈林 E-Mail:chenlin@ 日期:2017-1-10 ...
- linux 文件拷贝并替换,Linux_cmd replace 文件替换使用说明,帮助信息: 复制代码 代码如 - phpStudy...
cmd replace 文件替换使用说明 帮助信息: 复制代码 代码如下: 替换文件. REPLACE [drive1:][path1]filename [drive2:][path2] [/A] [ ...
- Simple Dynamic Strings(SDS)源码解析和使用说明二
在<Simple Dynamic Strings(SDS)源码解析和使用说明一>文中,我们分析了SDS库中数据的基本结构和创建.释放等方法.本文将介绍其一些其他方法及实现.(转载请指明出于 ...
- 使用Docsify搭建Markdown文件服务器
使用docsify快速生成文档网站 1. 概述 2. 安装 docsify-cli 工具 3. 初始化项目 4. 本地预览 5. 多页文档 6. 定制导航栏 6.1 在index.html中添加导航栏 ...
- Delphi开发的IOCP测试Demo以及使用说明。
Delphi开发的IOCP,此为压力测试Demo和使用说明.
- oracle database link mysql_oracle database link使用说明
oracle database link使用说明 作用: 将多个oracle数据库逻辑上看成一个数据库,也就是说在一个数据库中可以操作另一个数据库中的对象. 简易语法: CREATE [PUBLIC] ...
- 序列拼接工具Bowtie使用说明
序列拼接工具Bowtie使用说明 2011-06-08 ~ ADMIN Bowtie是一个超级快速的,较为节省内存的短序列拼接至模板基因组的工具.它在拼接35碱基长度的序列时,可以达到每小时2.5亿次 ...
- benchmarksql测试mysql_数据库压力测试工具 -- BenchmarkSQL 使用说明
关于数据库的压力测试,之前写过3篇Blog: 数据库基准测试(Database Benchmarking) 说明 数据库压力测试工具 -- Hammerdb 使用说明 数据库压力测试工具 -- Swi ...
最新文章
- 百度云满速下载(转)
- ORACLE---数据库巡检
- code Gym 100500D 	T-shirts(暴力)
- 蓝桥杯 算法提高 递推求值(矩阵快速幂)详解
- pycharm 如何导入、导出设置?
- Python 模块之 string.py
- 如何让多文本内容只显示一行,其余用省略号来显示
- CSS基础选择器(选择器的优先级),CSS样式块( 长度/颜色/显示方式/文本样式),盒模型组成,盒模型-block,盒模型布局...
- 李宏毅老师ML_HW1——PM2.5预测
- 游戏玩家都不爱 Windows 11?网友:没必要,Windows 10 足矣
- 用.net实现按透明度生成水印文件
- B站项目资源过于敏感,稍后删,抓紧保存!!!
- Flink 在人工智能领域的应用实践
- js实现浏览器打印PDF
- 数学四大思想八大方法_高中数学八种思维方法如何训练数学思维,高中数学的四大思想是什么?...
- 基于python技术的超市仓库管理系统
- 哪些服务器适合使用固态硬盘,服务器用固态硬盘还是机械硬盘合适?
- 微信app用户及市场调研
- 互联网时代“陨落”,国家发布元宇宙战略的信号对失业和担心失业的我们带来了什么启迪?
- 亚古兽的进化之路——从Model_Builder,工具箱到python工具箱
热门文章
- centos 7 edb安装
- java quickfix_用Quickfix详解Fix(一)
- 数据分析与Excel(一)
- java连接as400数据库,连接到AS400 DB2服务器JDBC时出错
- S7-200SMART PLC如何使用MicroSD存储卡来进行程序传输和固件更新?
- 2019_GDUT_新生专题I选集——C
- 功率放大器的指标是什么意思(功率放大器P1dB指标是什么)
- 架构设计之如何写架构设计说明书
- USB Gadget iMX6U	LL开发板模拟U盘
- RabbitMQ#RabbitMQ+Haproxy消息队列集群和代理部署