使用docsify搭建在线文档中心
准备工作
1、电脑已安装好node 和npm 环境。
2、编辑Markdown文件推荐下载Typora。
点击Typora官网下载吧~
3、对Markdown语法有一定的了解。
点击Markdown语法教程去学习吧~
docsify安装
官网：https://docsify.js.org
1、通过npm全局安装docsify-cli工具
npm i docsify-cli -g
2、初始化项目
docsify init ./docs
3、启动服务
docsify serve docs
# 默认端口3000
# 若启动多个docsify服务，后续启动的服务端口将会随机生成
4、浏览器访问
访问http://localhost:3000
定制化
docsify提供丰富的定制化配置项，可以查阅其官网文档去添加你感兴趣的配置项
例如：
新增首页
1、在index.html中新增配置项：
coverpage: true
2、在./docs目录下新建_coverpage.md 文件，并添加一些内容，这些内容可以自己自定义：
如：
# 标题## 小标题> 简介[地址](https://www.baidu.com) [开始阅读](#Headline)3、保存_coverpage.md ，浏览器会自动刷新：
新增侧边栏
1、在index.html中新增配置项：
loadSidebar: true
2、在./docs目录下新建_sidebar.md 文件，并添加一些内容，这些内容可以自己自定义：
如：
- [第一章](files/第一小节.md)- [第一小节](files/第一小节.md) - [第二小节](files/第二小节.md) - [第三小节](files/第三小节.md)
同时我在./files/目录下新建了三个文件：
3、保存_sidebar.md ，浏览器会自动刷新：
其他的定制配置项可参考docsify官网
部署到GitHub
要想通过域名在线去访问我们的文档，需要将上述编辑好的docsify发布到git代码托管平台，此处Github为例。
国内的Gitee也可以部署，只是现在Gitee需要上传个人身份证照片，步骤略微麻烦，感兴趣的可以自己去捣鼓一下。
1、在Github个人仓库下新建一个新仓库
如：我新建的名称为simon.doc
2、本地代码上传至Github
3、开启Pages服务
4、访问https://zhangting0228.github.io/simon.doc/
使用docsify搭建在线文档中心相关推荐
- 使用VuePress搭建在线文档网站
使用VuePress搭建在线文档网站 在线文档 VuePress官方在线文档(opens new window) 搭建基本环境 # 将 VuePress 作为一个本地依赖安装 npm install ...
- Github+docsify打造在线文档网站
写在前面 搭建这个在线文档的目的是方便自己对学习笔记的查看,比较喜欢 docsify 的主题风格,所以没有用 Github Pages 直接给的主题,自己根据官方文档进行了配置,目前已经成功上线. 1 ...
- Sphinx+gitee+Read the Docs搭建在线文档系统
本文介绍一种在线文档系统的搭建,需要借助Sphinx.gitee和Read the Docs. Sphinx是一个功能强大的文档生成器,具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统 ...
- Windows下面搭建在线文档工具showdoc工具
坚持把遇到的问题整理出来,供大家参考(企鹅群:263130304),转载注明出处(方便大家找我要源码),对你有帮助请点个赞,如果存在不足之处请留意,不喜勿喷,欢迎大家相互交流学习.--沙果 个人小程序 ...
- showdoc windows 搭建_Windows 搭建在线文档工具showdoc工具
ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
- Windows 搭建在线文档工具showdoc工具
ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
- js预览本地word文档_Github+docsify打造在线文档
效果图如下 预览链接:https://a870439570.github.io/interview-docs 快速开始 首先先安装好npm和nodejs,这里就不做过多介绍了 自信安装即可 (http ...
- 内网搭建在线文档服务
步骤 安装 Node 和 NPM: 安装 git, gitbook,gitbook-cli: 配置 Gitlab Webhook: 创建 Webhook 监听服务: 编辑文档检查实时更新: 安装 No ...
- docker搭建在线文档showdoc
一.搭建showdoc 1.拉取镜像 docker pull registry.cn-shenzhen.aliyuncs.com/star7th/showdoc 2.将拉取的镜像重新命名并上传到自己的 ...
最新文章
- Xamarin.Android提示找不到mono.Android.Support.v4
- Linux内核--网络协议栈深入分析(二)--sk_buff的操作函数
- Duilib教程－HelloDuilib及DuiDesigner的简单使用
- 现在的娃娃有多智能？
- 穿戴式设备的用户体验设计-郝华奇
- LeetCode 627. 交换工资
- 在28岁这一年，我也成为了一名创业狗
- Windows Server 2008R2配置ISCS存储
- ios开发 将json格式数据上传服务器
- Java异常处理机制(基础知识)
- C++后台开发学习路线
- 中国曲谱网爬虫研究(Python)
- MMDetection框架入门教程（完全版）
- linux 中qq的安装程序,linux下的QQ安装、使用方法
- 三步实现西门子PLC远程监控
- 批量修改视频尺寸，如此操作简单又专业
- 深圳绿道最全资料合集_我是亲民_新浪博客
- 英语专业 计算机研究生就业,计算机会计英语专业毕业生太多 就业压力倍增
- 《京韵大鼓——大西厢》（骆玉笙）（唱词文本）
- 词云wordcloud+jieba