Docsify

标签： #Share

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

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

官网

https://docsify.js.org/#/zh-cn/quickstart

提前准备

安装Node.js 进行相关配置即可

快速开始

1.合适位置创建文件夹，作为根目录

2.文件夹下(cmd 当前文件夹)执行 npm i docsify-cli -g   

3.docsify init ./docs

开始写文档

初始化成功后，可以看到 ./docs 目录下创建的几个文件

index.html 入口文件
README.md 会做为主页内容渲染
.nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新网站内容

个人建议的基本配置

开启封面，好看的封面

文档书写时注意一级，二级标题，图片等

必要位置的Logo，文档标题，html标题等等

开启全局搜索功能

代码高亮

基本配置Demo

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Kerwin's Demo</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="vue.css">
  <link rel="icon" href="https://img.alicdn.com/tfs/TB1kCs_er_I8KJjy1XaXXbsxpXa-419-495.png" type="image/png">
</head>
<body>
  <div id="app"></div>
  <script>
    window.$docsify = {
      name: 'This is Kerwin Demo',
      repo: 'Kerwin',
	  coverpage: true,
	  search: 'auto',
	  search : [
        '/'
	  ],
	  search: {
		  placeholder: '搜索',
		  noData: 'No Results!'
	  }
    }
  </script>
  <script src="docsify.min.js"></script>
  <script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
  <script src="//unpkg.com/prismjs/components/prism-java.js"></script>
  <script src="//unpkg.com/prismjs/components/prism-python.js"></script>
  <script src="//unpkg.com/prismjs/components/prism-sql.js"></script>
</body>
</html>

GitHub部署

网上搜索资料即可，比较简单

命令

docsify serve docs  // 运行即可