熊孩子程序员
0%

文档网站生成器——docsify

发表于
本文字数： 1.1k 阅读时长 ≈ 1 分钟

docsify 可以快速生成文档网站，使用非常方便。并且支持部署到Github Pages。在这里记录一下docsify的常用设置，方便查询。

安装方法

安装及使用的方法可以参考官方文档，写的非常的详细。可以点击进入我的读书笔记，看看最终的效果。

favicon

修改index.html文件，在head标签中加入如下link标签。参考修改：8c488a。

1
2
3
<head>
  <link rel="icon" type="image/png" sizes="16x16" href="media/favicon-16x16-pk.png" />
</head>

title

修改index.html文件，在head标签中加入如下title标签。title会显示在浏览器标签上。参考修改：8c488a。

1
2
3
<head>
  <title>笔记</title>
</head>

name

修改index.html文件，在window.$docsify为name设置值。name会显示在侧边栏的顶端。参考修改：8c488a。

1
2
3
window.$docsify = {
  name: '新一代熊孩子程序员',
}

复制到剪切板

一键复制代码块中的代码。修改index.html文件，在body标志中加入如下插件。参考修改：cb0d94。

1
2
3
<body>
  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
</body>

新页面自动到顶端

打开新页面后自动到顶端。修改index.html文件，在window.$docsify设置auto2top为true。参考修改：85ba10。

1
2
3
window.$docsify = {
  auto2top: true,
}

自定义sidebar和navbar

  • navbar，导航栏，显示在页面右上角。参考修改：c79007
  • sidebar，侧边栏，显示在页面左边。参考修改：ca5816
  • 定义别名，避免递归查找导致页面打开慢。参考修改：25bf6f
  • 添加目录自动折叠，避免侧边栏太长。参考修改：7f2223

scroll-to-top按钮

参考修改：bd83ea