草庐IT

Docsify使用指南，使用Typora+Docsify打造最强、最轻量级的个人&团队文档，及免费和开源且低成本文档工具

菜的慌 2023-03-28 原文

随着学习知识的积累，我们需要掌握的知识越来越多，这是就有一个问题出现了，如何把我们学习到的知识整理起来，让我们更方便的去管理和阅读，同事还想把我们所学习到的知识分析个小伙伴。这是我们就需要一个很方便的味文档管理工具了，在这里就给大家介绍一个款在线免费开源的文档管工具【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安装，下一步下一步直到完成。

官网地址：https://nodejs.org/en/

 

验证安装

输入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地址是 https://librarycodes.gitee.io/docsify-plus/#/

 

页面修改更新

如果页面内容有修改更新到仓库了，可以点击更新个人页面

 

 

 

 

 好东西话不多说直接上源码。

Docsify-Plus演示：https://librarycodes.gitee.io/docsify-plus

Gitee源码地址：https://gitee.com/librarycodes/docsify-plus

GitHub源码地址：https://gitee.com/librarycodes/docsify-plus

Docsify官网：https://docsify.js.org/#/

 

最轻量级DocsifyspanstylecolorHTML5

有关Docsify使用指南，使用Typora+Docsify打造最强、最轻量级的个人&团队文档，及免费和开源且低成本文档工具的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封，在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

  9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。 最佳答案 首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

    我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库，所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

随机推荐