You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1.2 KiB

使用指南

本指南将详细介绍如何使用和配置这个文档站点。

配置docsify

index.html文件中你可以配置docsify的各种选项

window.$docsify = {
  // 配置文档目录
  basePath: '/doc',
  // 开启侧边栏
  loadSidebar: true,
  // 设置首页
  homepage: 'home.md'
  // 更多配置选项...
}

自定义侧边栏

编辑doc/_sidebar.md文件来配置侧边栏:

* [首页](home.md)
* [介绍](introduction.md)
* [快速开始](quickstart.md)
* [使用指南](guide.md)
* [常见问题](faq.md)

添加新页面

  1. doc目录下创建新的Markdown文件例如new-page.md
  2. _sidebar.md中添加对应的链接

自定义样式

你可以修改css/vue.css文件来调整文档的样式或者添加自定义的CSS文件。

添加插件

index.html文件中你可以添加docsify的插件来扩展功能

<!-- 添加搜索插件 -->
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>

<!-- 添加代码高亮插件 -->
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-javascript.min.js"></script>

Powered by TurnKey Linux.