当前位置: 首页 > 网站建设 > 使用docsify生成美观的文档系统

使用docsify生成美观的文档系统

网站建设 1条评论 2018-8-25 1,284 views

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

docsify非常简单使用,不需要额外的脚本支持,只需要创建一个 index.html 并引入相关.js就可以开始撰写文档。

特性

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

快速初始化

在开始之前希望您已经拥有HTML/JavaScript/CSS基础,以免遇到错误时不知所措。接着我们在WEB目录下新建一个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" rel="external nofollow" target = "_blank" >
</head>
<body>
  <div id="app"></div>
  <script>
    window.$docsify = {
      //...
    }
  </script>
  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</body>
</html>

上面的配置会自动读取WEB目录下的README.md文件(注意大小写)来进行渲染

设置导航栏

直接在body段内添加相关内容,比如:

<!--导航栏-->
<nav>
    <a href="https://www.xiaoz.me/" rel = "nofollow" target = "_blank" title = "小z博客">Blog</a> 
    <a href="https://imgurl.org/" rel="external nofollow" target = "_blank"  rel = "nofollow" target = "_blank" title = "ImgURL">免费图床</a> 
    <a href="http://soft.xiaoz.org/" rel="external nofollow" target = "_blank"  rel = "nofollow" target = "_blank" title = "小z博客软件库">软件库</a> 
    <a href="https://ip.awk.sh/" rel="external nofollow" target = "_blank"  rel = "nofollow" target = "_blank" title = "IPinfo">IP查询</a> 
</nav>
<!--导航栏END-->

显示的效果如下图:

添加全文搜索

需要额外加载搜索插件,引入相关.js并开启搜索功能

window.$docsify = {
    //设置搜索          
    search: {
        maxAge: 86400000, // 过期时间,单位毫秒,默认一天
        paths: 'auto', // or 'auto'
        placeholder: '搜索',

        noData: '找不到结果',

        // 搜索标题的最大程级, 1 - 6
        depth: 3
    } 
}
<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>

解决Google字体加载慢

docsify提供了多种主题风格,但是使用中发现每个主题都去加载了Google fonts,导致速度缓慢。

可以自行将CSS下载到本地,然后将fonts.googleapis.com替换为fonts.loli.net

其它说明

docsify功能远不止如此,如代码高亮、页脚、侧边栏等可参考官方文档:https://docsify.js.org/#/zh-cn/ 进一步设置。

总结

在遇见docsify之前,xiaoz已经尝试过多款文档管理系统,如之前博客提到的WikittenMinDoc ,从使用体验上来说,docsify纯静态,部署简单,渲染后的页面最为美观。而MinDoc 管理更加方便,大家可根据实际需要考虑,目前 xiaoz doc已将Mindoc替换为docsify

One thought on “使用docsify生成美观的文档系统”

发表评论

电子邮件地址不会被公开。 必填项已用*标注