Docsify使用指南,使用Typora+Docsify打造最强、最轻量级的个人团队文档,及免费和开源且低成本文档工具
随着学习知识的积累,我们需要掌握的知识越来越多,这是就有一个问题出现了,如何把我们学习到的知识整理起来,让我们更方便的去管理和阅读,同事还想把我们所学习到的知识分析个小伙伴。这是我们就需要一个很方便的味文档管理工具了,在这里就给大家介绍一个款在线免费开源的文档管工具【Docsify-Plus文档工具】。
【Docsify-Plus文档工具】是本人搭建的一款开箱即用的文档工具,只需下载源码 直接运行即可,无需编写代码,只需修改少量配置就可以搭建起自己的文档工具,配合【Gitee Pages】实现了低成本工具。
Docsify-Plus文档工具 是基于Docsify.js 配置的一套开源框架,实现了直接使用 Markdown标记语言发布文档。无需对Markdown文档进行任何的修改,直接在项目中创建.md的Markdown文档编辑,直接发布Markdown,发布完后直接访问项目即可。
docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html
文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 index.html
就可以开始编写文档并直接部署。
Docsify-Plus部署
Docsify-Plus文档更适合做帮助文档和笔记工具,还支持多种部署方式,
Docsify-Plus表情
Docsify-Plus文档默认配置有一百多个表情,丰富你的文档记录
Docsify-Plus开发教程
Docsify-Plus开发需要使用到node 开发环境,和docsify-cli依赖包
安装node环境
安装docsify-cli
之前,我们需要安装npm
包管理器,而安装了node.js
就会自动安装npm
安装node
官网下载安装程序,双击下载的exe安装,下一步下一步直到完成。
官网地址:Node.js
验证安装
输入node -v,npm -v输出版本就是安装成功了
#验证node
node -v#验证npm
npm -v
安装docsify-cli工具
推荐全局安装 docsify-cli
工具,可以方便地创建及在本地预览生成的文档。
#用npm安装全局工具
npm i docsify-cli -g
下载Docsify-Plus项目
#Gitee地址:
https://gitee.com/librarycodes/docsify-plus#GitHub地址:
https://github.com/shiming-git/docsify-plus
运行Docsify-Plus项目
默认运行端口为 3000 docs为Docsify-Plus的默认目录,此目录可自行更改,可改为更目录
#进入项目
cd
docsify serve docs
#启动项目
docsify serve docs
指定端口运行
-p 80 指定运行端口 为 80
docsify serve -p 80 docs
本地预览
游览器打开输入访问地址,http://{你的ID地址}:{你指定的端口}
http://localhost:3000
Docsify-Plus开发
目录介绍
docsify-plus #项目
|__ docs #文档目录 可选|__ contents #文档文件夹 可选|__ development.md #快速开始 页面文件|__ guide.md #指南 页面文件|__ zh-en #不同语言目录 可选|__ _coverpage.md #当前语言封面|__ _navbar.md #当前语言导航页面|__ _sidebar.md #当前语言菜单页面|__ README.md #当前语言首页面|__ 404.md #错误页面 可选|__ _coverpage.md #默认语言封面 可选|__ _navbar.md #默认语言导航 可选|__ _sidebar.md #默认语言菜单 可选|__ index.html #程序入口 必选 可配置|__ README.md #默认语言首页 可选
|__ .nojekyll #git配置
|__ LICENSE #git配置
|__ README.md #git说明页面
菜单列表路径
你可以简单地在你的 docsify 目录中创建更多的 markdown 文件,你可以在菜单_sidebar.md添加目录,系统菜单是以 相对路径 访问页面
将你自定义的菜单文件添加到菜单列表中 就可以预览文件内容了,项目 目录不是固定的开发者可根据自己的需要去修改文件路径,最终要将文件相对路径添加到菜单列表即可。
* [介绍](README.md)
* [快速开始](contents/development)
* [指南](contents/guide)
从侧边栏选择设置页面标题
页面的title
标签是从选定的侧边栏项目名称生成的。为了更好的显示,您可以通过在文件名后指定一个字符串来自定义标题。
* [指南](contents/guide "文档指南")
Docsify-Plus部署到gitee
windows安装git,管理页面
window上主要是日常博客的编写,然后用git来管理,上传到gitee后,可以配置生成GiteePages。具体的git操作和配置可以参考git详解文章,这里创建了一个gitee仓库,专门用来做个人网站。下面红框框出来的是docsify生成的几个配置文件。
Gitee配置Gitee Pages
第一次配置需要实名认证,上传身份证正反面,手持身份证照片。
部署选择你要部署的分支,部署的目录就是docsify对应仓库中的目录,我这边是整个仓库作为docsify目录,建议强制使用https勾选,然后就可以启动。
页面效果请参考
效果地址giteePages地址是 开源低成本在线免费文档
页面修改更新
如果页面内容有修改更新到仓库了,可以点击更新个人页面
好东西话不多说直接上源码。
Docsify-Plus演示:开源低成本在线免费文档
Gitee源码地址:Docsify-Plus: 开源低成本在线免费文档
GitHub源码地址:Docsify-Plus: 开源低成本在线免费文档
Docsify官网:docsify
Docsify使用指南,使用Typora+Docsify打造最强、最轻量级的个人团队文档,及免费和开源且低成本文档工具相关推荐
- GitHub Pages + Hexo + NexT + Typora + WhatsNote打造完美个人知识共享博客
GitHub Pages + Hexo + NexT + Typora + WhatsNote打造完美个人知识共享博客 一.目标 二.理念 三.准备工作 1. 工具 2. 过程 四.实现过程 1. 搭 ...
- emby ios 收费_点播、直播一条龙,使用Jellyfin打造最强媒体中心(篇一)
点播.直播一条龙,使用Jellyfin打造最强媒体中心(篇一) 2019-07-14 17:20:54 415点赞 5732收藏 407评论 小编注:此篇文章来自即可瓜分10万金币,周边好礼达标就有, ...
- Typora实现云笔记,支持云同步+多端查看(附免费方案)
Typora实现云笔记,支持云同步+多端查看(附免费方案) 说明 Typora是一款非常优秀的markdown编辑器,可惜的是只支持本地编写,无法进行云备份和同步. 这篇文章将介绍,如何通过多款软件协 ...
- 解读阿里云AI产品矩阵:目标是打造最强中国云计算能力
在近日举办的阿里云栖大会武汉峰会上,阿里云AI产品矩阵的亮相作为压轴大戏出场,这也是阿里云首次曝光了人工智能产品家族,全方位公开AI产品体系,AI作为阿里云,乃至阿里巴巴集团技术应用和市场战略的重要一 ...
- 树莓派4外置wifi天线_树莓派打造最强车载娱乐终端(1)音乐和WiFi
开车跑长途的时候总觉得无聊,就会想起飞机上的娱乐终端,那么我们就来自己做一个吧! 这一系列文章里,我会按照功能划分,列出需要的软硬件,尽量做到互相独立,方便自由组合.今天我们先来实现最基本的音乐播放和 ...
- UPA论坛归来:没有最好,只有更适合——打造更有价值的用户体验团队
9月19日,项目组组织参加了在深圳腾讯举行的专家论坛:"没有最好,只有更适合--打造更有价值的用户体验团队".来自华为.腾讯.金蝶.中兴的六位嘉宾,大约八十余UCD相关团队成员参加 ...
- 如何打造一支优秀的技术团队?
如何打造一支优秀的技术团队?我1998 年毕业,至今工作了将近 20 年的时间.我写了很多年程序,在早期编程的时候,我的领导觉得我是一个适合做团队管理和协调的人,因此我做了很多年的技术团队管理工作.h ...
- 单机大天使服务器端修改商店,《大天使之剑h5》变态单机版最新开服_无限钻石打造最强阵容_满V公益私服...
原标题:<大天使之剑h5>变态单机版最新开服_无限钻石打造最强阵容_满V公益私服 <大天使之剑>www.74uw.com 要想玩好一个游戏,开局是非常重要的,只有少走点弯路,才 ...
- 打造最强终端之一:Fish shell简明教程
原文地址:https://kxcblog.com 本系列文章包括3篇,主要分享我在后端开发过程中使用终端的一些经验和心得,分享fish shell使用,使用tmux终端复用管理会话.窗口,以及vim插 ...
最新文章
- Logback中文文档(四):Appender
- JDK 5.0 注解的使用
- Android开发--Input/OutputStream操作
- 5g宣传方案_5G时代来了,VR如何玩转线上营销新模式
- Yarn的三种资源调度机制
- JavaWeb笔记04-解决GET与POST乱码问题
- 【python基础】ValueError: only 2 non-keyword arguments accepte
- 第13届 广东工业大学ACM程序设计大赛 C题 平分游戏
- Server Tomcat v8.0 Server at localhost failed to start.
- 2021-2022年数学建模资料汇总——建模软件篇
- 常见网络安全威胁及防范
- 50台计算机教室怎样布线,电教室布线技巧有哪些?
- 论文翻译3-视频流SR技术分析
- ios-vcf格式通讯录的生成
- oracle查询年份的后两位,Oracle对2位年份的处理
- [原创]作弊教室-你想作弊?小心旁边的人成绩比你还差
- HTML进行表单验证
- 一张图分出你是用左脑还是右脑!
- 解决Microsoft Store无法下载软件问题
- [转]公司网管员未来职业规划