简介

一个神奇的文档网站生成器。

简单而轻便（〜18kB压缩）

没有静态构建的HTML文件

多个主题

快速开始

建议docsify-cli全局安装，这有助于本地初始化和预览网站。

npm i docsify-cli -g

初始化

如果在根目录中编写文档

docsify init ./

写作内容

在之后init完成后，你可以看到在文件列表./根目录。

  • index.html 作为入口文件
  • README.md 作为主页
  • .nojekyll 防止GitHub页面忽略以下划线开头的文件

您可以轻松更新文档./README.md，当然您可以添加更多页面。

侧边栏

为了有侧边栏，那么你可以创建你自己的_sidebar.md：

首先，你需要设置loadSidebar为true。详细信息可在配置段落中找到。

<!-- index.html -->

<script>

  window.$docsify = {

    loadSidebar: true

  }

</script>

<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

创建_sidebar.md：

<!-- docs/_sidebar.md -->

- [Home](/)

- [Guide](guide.md)

其他详细配置情参考官方文档

配置index.html

下面是我参考官方文档修改的一个配置:

<!DOCTYPE html>

<html lang="en">

<head>

  <meta charset="UTF-8">

  <title>Document</title>

  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />

  <meta name="description" content="Description">

  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">

  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">

</head>

<body>

  <div id="app">Please wait...</div>

  <script>

    window.$docsify = {

      auto2top: true, //当路线改变时，滚动到屏幕的顶部。

      coverpage: true, //激活封面功能。如果为true，则会从中加载_coverpage.md。

      executeScript: true, //执行页面上的脚本。只解析第一个脚本标记（演示）。如果存在Vue，则默认开启。

      loadSidebar: true, //_sidebar.md如果为真，则从_sidebar.md文件加载边栏，否则从指定的路径加载。

      loadNavbar: true,//_navbar.md如果为真，则从_navbar.md文件加载navbar ，否则从指定的路径加载。

      mergeNavbar: true,//Navbar将在小屏幕上与侧边栏合并。

      maxLevel: 4,//最大的内容表级别。

      subMaxLevel: 2,//在自定义边栏中添加目录（TOC）。

      ga: 'UA-106147152-1',

      name: 'docsify',

      search: {

        noData: {

          '/de-de/': 'Keine Ergebnisse!',

          '/zh-cn/': '没有结果!',

          '/': 'No results!'

        },

        paths: 'auto',

        placeholder: {

          '/de-de/': 'Suche',

          '/zh-cn/': '搜索',

          '/': 'Search'

        }

      },

      formatUpdated: '{MM}/{DD} {HH}:{mm}',

      plugins: [

        function(hook, vm) {

          hook.beforeEach(function (html) {

            var url = 'https://github.com/PYfive/docsify/blob/master/' + vm.route.file

            var editHtml = '[:memo: Edit Document](' + url + ')\n'

            return html

              + '\n----\n'

              + 'Last modified {docsify-updated} '

              + editHtml

          })

        }

      ]

    }

  </script>

  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

  <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>

  <script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>

  <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>

  <script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>

  <script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>

</body>

</html>

运行

docsify serve --port 4000

访问 http:/localhost:4000 即可查看页面效果

总结

docsify用法和gitbook差不多，但是样式比较好看，个人比较喜欢。

docsify简单教程的更多相关文章

  1. Git和Github简单教程

    原文链接:Git和Github简单教程 网络上关于Git和GitHub的教程不少,但是这些教程有的命令太少不够用,有的命令太多,使得初期学习的时候需要额外花不少时间在一些当前用不到的命令上. 这篇文章 ...

  2. FusionCharts简单教程(三)-----如何自定义图表上的工具提示

    最近有蛮多人总是问我这个FusionCharts制表的问题,帮助他们解决之后,在昨晚发现以前整理的笔记中有这个简单教程,而且以前也发表了几篇这个博文,所以就将其全部上传上来供别人参考.如有不正确之处望 ...

  3. FusionCharts简单教程(八)-----使用网格组件

            有时候我们会觉得使用图像不够直接,对于数据的显示没有表格那样直接明了.所以这里就介绍如何使用网格组件.将网格与图像结合起来.网格组件能够将FusionCharts中的单序列数据以列表的 ...

  4. Qt Quick 简单教程

    上一篇<Qt Quick 之 Hello World 图文详解>我们已经分别在电脑和 Android 手机上运行了第一个 Qt Quick 示例—— HelloQtQuickApp ,这篇 ...

  5. Git和Github简单教程(收藏)

    原文链接:Git和Github简单教程 目录: 零.Git是什么 一.Git的主要功能:版本控制 二.概览 三.Git for Windows软件安装 四.本地Git的使用 五.Github与Git的 ...

  6. mysql安装简单教程(自动安装/配置安装)

    mysql安装简单教程(自动安装/配置安装) 1.1前言: 由于特殊原因,在最近2-3个月里mysql真是安装了无数遍,每次安装都要上网找教程,每个教程基本都不一样,因此还是自己写下来比较好,毕竟自己 ...

  7. 平衡树简单教程及模板（splay, 替罪羊树, 非旋treap）

    原文链接https://www.cnblogs.com/zhouzhendong/p/Balanced-Binary-Tree.html 注意是简单教程,不是入门教程. splay 1. 旋转: 假设 ...

  8. LayaAir引擎开发HTML5最简单教程(面向JS开发者)

    LayaAir引擎开发HTML5最简单教程(面向JS开发者) 一.总结 一句话总结:开发游戏还是得用游戏引擎来开发,其实很简单啦 切记:开发游戏还是得用游戏引擎来开发,其实很简单,引擎很多东西都帮你做 ...

  9. mockito简单教程

    注:本文来源:sdyy321的<mockito简单教程> 官网: http://mockito.org API文档:http://docs.mockito.googlecode.com/h ...

随机推荐

  1. MyCat of Middleware

    第一章 入门概述 1.1 是什么 Mycat 是数据库中间件. 1.数据库中间件 中间件:是一类连接软件组件和应用的计算机软件,以便于软件各部件之间的沟通. 例子:Tomcat,web中间件. 数据库 ...

  2. Travis CI Build Continuous Integration

    什么是持续集成 持续集成(Continuous Integration)是经常合并小的代码更改的实践,而不是在开发周期结束时合并大的更改.目的是通过以较小的增量开发和测试来构建更健康的软件.这就是Tr ...

  3. oracle常见的函数

    1.字符函数 -- initcap函数只针对英文 select * from tb_user where user_name = initcap('张三'); -- ltrim 左剪切 select ...

  4. SpringBoot2.x整合Shiro出现cors跨域问题（踩坑记录）

    1. Springboot如何跨域? 最简单的方法是: 定义一个配置CorsConfig类即可(是不是简单且无耦合到令人发指) @Configuration public class CorsConf ...

  5. ntpdate 设置时区（注意本地时区要设置正确）

    修改timezone sudo cp -a /usr/share/zoneinfo/Etc/GMT-8  /etc/localtime date -R   == 展示当前的timezone ntpda ...

  6. 「题解」「JOISC 2014 Day1」历史研究

    目录 题目 考场思考 思路分析及标程 题目 点这里 考场思考 大概是标准的莫队吧,离散之后来一个线段树加莫队就可以了. 时间复杂度 \(\mathcal O(n\sqrt n\log n)\) . 然 ...

  7. CSS水平垂直居中常见方法总结

    1.元素水平居中 当然最好使的是: margin: 0 auto; 居中不好使的原因: 1.元素没有设置宽度,没有宽度怎么居中嘛! 2.设置了宽度依然不好使,你设置的是行内元素吧,行内元素和块元素的区 ...

  8. 吴裕雄 python 神经网络——TensorFlow 花瓣分类与迁移学习（2）

    import glob import os.path import numpy as np import tensorflow as tf from tensorflow.python.platfor ...

  9. Pipenv & 虚拟环境

    本教程将引导您完成安装和使用 Python 包. 它将向您展示如何安装和使用必要的工具,并就最佳做法做出强烈推荐.请记住, Python 用于许多不同的目的.准确地说,您希望如何管理依赖项可能会根据 ...

  10. python第一章 python基础编程

    第一次学习python 首先python对于我来说是我学习的第三门语言,之前大一学习过了c和c++这两门语言. 接触一个新语言,首先应该的是搭载一下编译的环境.我们是老师给我们上传了的python3安 ...