简介

        刚刚写完mdwiki，没多长时间就发现了可替代的软件。docsify使用方法和mdwiki很接近，非常非常接近。

        官网：https://docsify.js.org

        GitHub：https://github.com/docsifyjs/docsify/

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

特点

• 无需构建，写完文档直接发布

• 容易使用并且轻量 (~19kB gzipped)

• 智能的全文搜索

• 提供多套主题

• 丰富的 API

• 支持 Emoji

• 兼容 IE10+

• 支持 SSR

操作步骤

        需要安装：

• node.js

• Git

        关于安装教程可以参考我这篇文章

Hexo博客安装教程

专栏

RWYQ阿伟

597阅读  3回复

        安装工具

        随便一个地方打开

        输入命令：

        npm i docsify-cli -g

        注意这里是全局安装。

        新建一个文件夹，比如

        进入这个文件夹，鼠标右击

        输入命令：

        docsify init

        初始化项目。

        然后这个文件夹内会多出几个文件，整体目录如下：

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

        我们可以预览一下

        输入命令：

        docsify serve

        浏览器输入：localhost:3000

        效果如下

        这个页面是响应式，可以手机端浏览。

        浏览器中显示的正是文件里面的内容。

        在浏览器中左侧栏显示标题，右侧显示内容。

        只需要md文件即可，不用转换成html文件。

        在某个地址链接下，默认访问的就是这个文件，如果访问别的文件，在路径后加上这个文件名。

        假设你的文件目录如下：

docs / ├── folder / ├── README.md ├── XXX.md ├── .nojekyll   ├── index.html ├── README.md └── XXX.md

        对应的页面访问：

        http://localhost:3000/                       <=>     docs/README.md         http://localhost:3000/XXX               <=>     docs/XXX.md         http://localhost:3000/folder              <=>     docs/folder/README.md         http://localhost:3000/folder/XXX     <=>     docs/folder/XXX.md

侧边栏

        默认情况下侧边栏会通过 Markdown 文件自动生成，效果如当前的文档的侧边栏。需要创建你自己的侧边栏，需要通过以下步骤。

1. 修改html配置信息。

2. 创建你自己的_sidebar.md文件。

        添加这一句代码，不要忘了在上一句后面加一个逗号。这个问题居然困扰了我好久。

        然后在同一目录下创建一个文件。

        随便写一点内容：

* [首页](/) * [Markdown语法参考](/MD.md)

        大概就是这个样子。

标题栏

        当然你可以使用html自己写一个出来。这里我简单说一下的方式创建标题栏。

1. 修改html配置信息。

2. 创建你自己的_navbar.md文件。

        同目录下创建一个文件：

        写一点内容：

* Getting started   * [Quick start](quickstart.md)   * [Writing more pages](more-pages.md)   * [Custom navbar](custom-navbar.md)   * [Cover page](cover.md) * Configuration   * [Configuration](configuration.md)   * [Themes](themes.md)   * [Using plugins](plugins.md)   * [Markdown configuration](markdown.md)   * [Language highlight](language-highlight.md)

       前面是显示的内容，后面是链接的文件。 这是官方文档给出的案例，没有实在文件，链接里面的文件需要你自己来写。

        效果：

        注意别写三级菜单了，显示有点问题，效果不太好。

总结

        总的来说是一个简单方便的文档管理软件，相比，这个样式我很喜欢，还有这个软件一直有在维护。

        一个文件夹就是一个wiki，文件夹下README.md就是主页。左侧的导航可以是文件内容的一级二级标题，也可以是我们自定义的链接，可以多个wiki，多级目录，用起来非常灵活。

        它的主题不多，都是这一个布局风格，仅仅只是颜色不同。

        测试链接：http://www.rwyqboy.top/docs

最后

        只是简单介绍了一下如何使用把文档生成网站。类似的软件其实有很多，比如Gitbook。关于这个软件的更多功能请移步官网文档查看。

        下面这个网站是收录GitHub上面的静态网站相关的项目，有兴趣的同学可以了解一下。

        https://www.staticgen.com/

        我做了很多尝试，发现无论还是对公式支持效果不是很好，总是刷新一下才能出现。网上没有查到什么有意义的信息，希望路过大佬指点一下。

        本文软件图片素材全部来源于网络，旨在学习和娱乐之用，如有侵权请联系我立即删除。