原文链接

个人博客-欢迎访问

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。

这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 .html 文件“污染” commit 记录，只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。

特性

无需构建，写完文档直接发布
容易使用并且轻量 (~19kB gzipped)
智能的全文搜索
提供多套主题
丰富的 API
支持 Emoji
兼容 IE10+
支持 SSR (example)

快速开始

推荐安装 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 可以方便的预览效果，而且提供 LiveReload 功能，可以让实时的预览。默认访问 http://localhost:3000 。

docsify serve docs
复制代码

更多命令行工具用法，参考 docsify-cli 文档。

手动初始化

如果不喜欢 npm 或者觉得安装工具太麻烦，我们其实只需要直接创建一个 index.html 文件。

// index.html<!DOCTYPE html>
<html>
<head><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><meta name="viewport" content="width=device-width,initial-scale=1"><meta charset="UTF-8"><link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body><div id="app"></div><script>window.$docsify = {//...}</script><script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</body>
</html>
复制代码

如果系统里安装 Python 的话，也可以很轻易的启动一个静态服务器。

cd docs && python -m SimpleHTTPServer 3000
复制代码

Loading 提示

初始化时会显示 Loading... 内容，你可以自定义提示信息。

// index.html<div id="app">加载中</div>
复制代码

如果更改了 el 的配置，需要将该元素加上 data-app 属性。

// index.html<div data-app id="main">加载中</div><script>window.$docsify = {el: '#main'}</script>复制代码

示例

这是一份docsify开发的文档欢迎点击查看

git地址
线上预览

更加详细的设置配置参考官方文档

转载于:https://juejin.im/post/5c8a03a75188257e9044ec19

docsify神奇的文档网站生成工具相关推荐

使用docsify构建专业文档网站(上)
tags: docsify doc github 文章目录 1.引言 2.docsify简介 3. 使用docsify构建文档 3.1 构建docsify目录结构 3.1.1 目录结构 3.1.2 编 ...
Java实现生成数据库表结构文档（生成工具screw的使用）
目录一.screw介绍 1.简介 2.特点 3.文档格式二.生成方式 2.1 方式1:使用 Java 代码 2.1.1 引入依赖 2.1.2 编写代码 2.1.3 测试 2.2 方式2:使用 Sp ...
python docx 合并文档图片_MBT文档模型化生成工具——30倍效率文档撰写工程化方法...
MBT(A model based document builder)文档模型化生成工具用户手册--30倍效率文档撰写工程化方法 1 简介在软件工程领域,工程文档通常主要包括实施方案.需求分析.软件 ...
Github+docsify打造在线文档网站
写在前面搭建这个在线文档的目的是方便自己对学习笔记的查看,比较喜欢 docsify 的主题风格,所以没有用 Github Pages 直接给的主题,自己根据官方文档进行了配置,目前已经成功上线. 1 ...
Java api文档自动生成工具smartdoc+torna
首先,一般做java服务端都用过postman,并且都写过前端调用的api文档接口,并且也用过市面上的一些工具. API自文档动生成,能够省去了写文档的时间. 当然,当前也会有很多类似的开源工具,我们 ...
使用docsify构建专业文档网站(下)
tags: docsify doc github 文章目录 1.引言 2.使用`Github Pages`部署文档 3.使用`Gitalk`添加评论功能 3.1 gitalk介绍 3.2 引入gita ...
几个在线文档接口生成工具
好用的在线文档生成工具,具体要求如下: 1.能够实时生成在线文档 2.支持全文搜索 3.支持在线调试功能 4.界面美观说实话,这个需求看起来简单,但是实际上一点的都不简单. 我花了几天时间到处百度, ...
java如何生成api文档_api文档自动生成工具
java开发,根据代码自动生成api接口文档工具,支持RESTful风格,今天我们来学一下api-doc的生成预览在线预览地址开发原理这个工具是一个典型的前后端分离开发的项目,想了解前后端分离 ...
SmartSQL - 最方便、快捷的数据库文档查询生成工具（推荐）
SmartSQL ⚡一款方便.快捷的数据库文档查询.生成工具

docsify神奇的文档网站生成工具

特性