之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协作工具 docsify:一个神奇的文档站点生成器,简单轻巧,无需静态构建html 教程版: http://me.52fhy.com/learn-markdown-generate-tool/#/ loppo 官网: https://github.com/ruanyf/loppo 依赖 node.js

docsify , 网站文档动态生成工具,类似gitbook 特性 无需构建,写完文档直接发布 容易使用并且轻量 (~19kB gzipped) 智能的全文搜索 提供多套主题 丰富的 API 支持 Emoji 兼容 IE10+ 支持 SSR 安装 npm i docsify-cli -g 进入项目根目录并初始化 docsify init ./docs 之后docs目录下会生成以下几个文件 index.html 入口文件 README.md 会做为主页内容渲染 .nojekyll 用于阻止 Git

背景 经常在网上看到一些排版非常漂亮的技术手册,左边有目录栏,右边是Markdown格式的文档,整个配色都十分舒服,就像一本书一样,一看就很让人喜欢.就比如Markdown Preview Enhanced的文档.目前网上我了解的有两种工具可以实现这样的效果,一种叫做docsify,另一种叫做Gitbook.因为MPE文档用的是docsify,而且据docsify自己的宣传,说是 不同于 GitBook.Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行

本文主要参考资料为该网址:https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md 如何想使用现成的gitbook,网络上虽说可以搜索的到,但是要使用,可能会受到限制,需要翻墙. 但是通过这种方式,就不必翻墙,可以作为公司内部文档或者是自己的开源项目介绍等. 步骤如下(以生成一个blog文档为例): 全局安装gitbook-cli npm install gitbook-cli -g 初始化 gitbook init ./blo

简介 一个神奇的文档网站生成器. 简单而轻便(〜18kB压缩) 没有静态构建的HTML文件 多个主题 快速开始 建议docsify-cli全局安装,这有助于本地初始化和预览网站. npm i docsify-cli -g 初始化 如果在根目录中编写文档 docsify init ./ 写作内容 在之后init完成后,你可以看到在文件列表./根目录. index.html 作为入口文件 README.md 作为主页 .nojekyll 防止GitHub页面忽略以下划线开头的文件 您可以轻松更新文档

之前由于学摄影的关系,为了提高自己的审美,顺便锻炼下自己的英文能力,翻译了不少国外艺术类的 文章.最近一直想搭一个个人博客来存放这些内容,又懒得折腾建站,遂一直搁置. 直到偶然发现了 docsify 和 Serverless Framework,建站一下子变得特别容易 -- 用 docsify 创建博客系统,然后用 Serverless Framework 部署服务,三分钟就搞定了! 简单介绍一下: docsify:一个神奇的文档网站生成工具,不同于 GitBook.Hexo 的地方是它不会生成

使用docsify 写开源文档 官网:https://docsify.js.org/#/ docsify 是一个动态生成文档网站的工具.不同于 GitBook.Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行. 这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件"污染" commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages. 一.初始化

前提 下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介 docsify是一个神奇的文档网站生成器.他可以快速帮你生成文档网站.不同于GitBook.Hexo的地方是它不会生成静态的.html文件,所有转换工作都是在运行时.如果你想要开始使用他,只需要创建一个index.html就可以开始编写文档并直接部署在GitHub Pages(码云Pages.阿某云OSS或者鹅云COS等等).它的主要特性如下: 无需构建,写完文档直接发布(运行时markdown文

layout: postcategory: javatitle: 入坑 docsify,一款神奇的文档生成利器!tagline: by 沉默王二tags: - java Guide 哥是我认识的一个非常优秀的年轻人,胖嘟嘟的身躯里充斥着无穷无尽的才华,他的 JavaGuide 在 GitHub 上已经标星 91K+ 了,空闲的时候我都会上去瞅两眼,毕竟学习使我快乐,嘿嘿. 有一天,我发现,他整的那个在线版看起来非常漂亮,我就问他用什么做的,他就会回我说,"docsify,很方便."刚好

为啥要用docsify? 神器Docsify让你的文档变得美观,配合typora,从此爱上看文档,各种优点:小巧.快速.美观.方便.快捷.上手快,可以浏览如下优秀案例 ve-charts pyecharts pyecharts-gallery 处于萌芽阶段的 Java 核心知识库 更多案例请看:Awesome Docsify 安装 1.首先安装npm: sudo apt install npm 如果报错,则执行如下命令安装相关依赖 sudo apt-get install nodejs-dev

话不多说,先看效果: https://bytesfly.github.io/blog 为什么需要一个站点 肯定有人会问,既然有类似 博客园 这样优秀的平台来写博客,为什么还需要自己搭建站点呢? 放在GitHub上托管,可以使用Git追踪博客内容的变更,就像维护代码一样,更加清晰明了,数据也不会丢失. 大多优秀的开源项目,官方文档也很正式,如果用博客园来写貌似有点不合适,此时就需要一个独立的官方文档站点. 如果你想免费搭建属于自己的个人站点,甚至用于一个公司.组织的官网,GitHub Pages也

前言 base-admin从开源至今,已经收获了2k Stat,而我们一直都没有一份像样的在线文档,最近写了一个博客园随笔备份Java脚本,将博客随笔备份到本地,格式是md文档格式,就有意去找将md文档转成html的工具,最后选用了下面这个文档网站生成器,经过一段时间的学习.编写文档,配合Gitee Pages服务,重要有了一个像样的项目网站 https://huanzi-qch.gitee.io/base-admin 文档网站生成器 docsify 一个神奇的文档网站生成器,官网:https:

前言 网上关于动态文档生成工具有很多如:Docsify. VuePress.Docute .Hexo这些都是一些非常优秀的文档生成工具,本章主要介绍如何快速使用Docsify搭建一个快捷.轻量级的个人&团队文档. 什么是Docsify? 一个神奇的文档网站生成器.docsify 可以快速帮你生成文档网站.不同于 GitBook.Hexo 的地方是它不会生成静态的 .html 文件,所有转换工作都是在运行时.如果你想要开始使用它,只需要创建一个 index.html 就可以开始编写文档. Docs

什么是Docsify? 一个神奇的文档网站生成器.docsify 可以快速帮你生成文档网站.不同于 GitBook.Hexo 的地方是它不会生成静态的 .html 文件,所有转换工作都是在运行时.如果你想要开始使用它,只需要创建一个 index.html 就可以开始编写文档. Docsify使用指南 Docsify使用指南(打造最快捷.最轻量级的个人&团队文档) Windows10 IIS Web服务器安装配置 详情参考:Windows10 IIS Web服务器安装配置 打开IIS并添加Docs

需求分析 文档可以和项目一起进行版本管理 文档可以在线访问 文档可以与springboot项目集成,不需要分开部署 MarkDown支持 文档跟随,打包jar也可以访问 技术选型 对于网上已有的方案,大致分为如下几种 将文档部署在 resource静态资源目录下,用模板渲染访问.\(^{[1]}\) 分离部署,打包 jar后还需要单独上传静态资源文档内容并部署. 最终选定的技术方案如下 工具 用途 官网 Typora 文档编写 https://typoraio.cn/ Docsify 文档部署

最近需要在GitBook中去阅读电子书 安装nodejs cnpm安装gitbook 解压书籍文件,并cd到书籍文件目录 gitbook serve 浏览器访问localhost:4000 先在windows 下安装nodejs 官网:https://nodejs.org/en/ 下载后直接安装即可 然后通过cmd调出DOS命令窗口测试下是否安装完成 输入命令:node 输入:console.log("Hello,World!");测试一下 在D盘下建立一个app文件夹,app文件夹里

简介 GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书.GitBook支持输出以下几种文档格式 静态站点:GitBook默认输出该种格式 PDF:需要安装gitbook-pdf依赖 eBook:需要安装ebook-convert 准备安装 在使用GitBook 之前, 我们需要先安装一些必须的工具,Node.js.GitBook.GitBook Editor.Git版本控制器. Node.js Node.js 是一个

安装了GitBook,内网使用,没法用上gitbook的网页. 用gitbook serve只能展示一本书,而且也不利于长期维护. 于是使用gitlab,jenkins,和nginx配合gitbook使用. 基本的流程是这样的,每本书作为项目托管到gitlab上,每次提交,gitlab会触发jenkins,jenkins会把仓库的内容拉下来,gitbook build 并复制到Web server(Nginx)的目录下,并加上可读权限,然后局域网内的人就都可以直接访问了. 下面记录过程 首先机器

GitBook 是一款基于 Node.js 开发的开源的工具,可以通过命令行的方式创建电子书项目,再使用 MarkDown 编写电子书内容,然后生成 PDF.ePub.mobi 格式的电子书,或生成一个静态站点. 除此之外,还可以利用 Git 命令管理电子书版本.如果你是 GitHub 的重度使用者,还可以把你的 GitBook 帐户和 GitHub 帐户关联起来,这样不论在任何一方修改了内容,都可以互相同步. 一.安装 Node.js 由于 GitBook 是基于 Node.js 开发的,所以

Just released an open source Cassandra Gitbook for developer. http://teddymaef.github.io/learncassandra/en/ Chinese version is not translated yet. Welcome for any suggestions and contribution.