docsify使用记录

Docsify 是什么？

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

较多使用的场景是GitHub中对某一开源程序的文档介绍，由于docsify的主题较为好看， 且轻量、易使用，因此使用也较为广泛。同时它也支持很多插件来丰富功能。但跟Hexo相比，个人感官上Hexo更适合做个人博客， 而docsify更适合专门来写程序的介绍文档

---

春招的时候背了很多的面经， 只不过秋招回头来看基本上又都记不太清了，于是想自己整理些面经笔记啥的。 之前也试过在个人博客上发表， 只不过感觉还是不适合阅读，因此正好想起来之前了解过Docsify，因此这次打算在写面经的时候顺便也练习、熟练下Docsify。

官方文档快速使用介绍的很全了，先贴个官方文档。

Start to Run it

1.安装docsify工具:npm i docsify-cli -g
2.初始化项目: docsify init [./docs] , []中内容为指定生成目录, 不填默认为当前目录
初始化成功后，可以看到生成 目录下创建的几个文件

• index.html 入口文件、插件等配置都写在这
• README.md 会做为主页内容渲染，编辑即可更新文档内容
• .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

3.预览效果： docsify serve [docs]， 通过运行 docsify serve 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 http://localhost:3000 。

---

多页文档

定制化

• 自定义导航栏: 设置为 true 后会加载 _navbar.md 文件，也可以自定义文件名。

• 自定义侧边栏: 设置为 true 后会加载 _sidebar.md 文件，也可以自定义文件名。

• 启用封面页: 开启后是加载 _coverpage.md 文件，也可以自定义文件名。

• markdown配置

插件

index.html

<script>
    window.$docsify = {
        name: 'Java工程师成神之路',
        repo: 'https://github.com/hollischuang/toBeTopJavaer',
          loadSidebar: true,
        subMaxLevel: 3,
        autoHeader: true,
        search: {
            paths: 'auto',
            placeholder: '🔍 搜索 ',
            noData: '哎呀，没有找到呀！ ',
            // Headline depth, 1 - 6
            depth: 3
        },
        copyCode: {
            buttonText : '复制',
            errorText  : 'Error',
            successText: 'OK!'
        },
        pagination: {
            previousText: '上一章',
            nextText: '下一章',
        },
        coverpage: true
    }
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<!--代码块复制插件-->
<script src="//unpkg.com/docsify-copy-code"></script>
<!-- 图片缩放插件 -->
<script src="https://cyc-1256109796.cos.ap-guangzhou.myqcloud.com/zoom-image.min.js"></script>
<!--搜索插件-->
<script src="https://cdn.bootcss.com/docsify/4.5.9/plugins/search.min.js"></script>
<!--语法高亮插件-->
<script src="//unpkg.com/prismjs/components/prism-java.min.js"></script>

<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
<!--分页插件-->
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
<!--统计访问量插件-->
<script async src="//busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js"></script>

附录：

To Be Top Javaer - Java工程师成神之路