当前位置：网站首页 > 文章教程 > 正文

Docsify-3分钟搭建属于自己的技术文档WIKI

yund56 2025-07-17 00:04 16 浏览

Docsify是什么

docsify 是一个动态生成文档网站的工具，可以将.md 文件以 wiki 的形式展示给读者，可以用于制作技术文档、用户手册、wiki 等。可以部署于主机、VPS、Github、静态云存储（例如阿里云 OSS）。

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

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

这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 .html 文件“污染” commit 记录，只需要创建一个 index.html

特性

无需构建，写完文档直接发布
容易使用并且轻量 (压缩后 ~21kB)
智能的全文搜索
提供多套主题
丰富的 API
支持 Emoji
兼容 IE11
支持服务端渲染 SSR (示例)

Docsify安装及使用

node安装

下载地址：https://nodejs.org/dist/v8.9.4/node-v8.9.4-x64.msi
下载完成后点击安装。
查看node 版本，命令：node -v
版本：v8.9.4

docsify安装

npm i docsify-cli -g
docsify init ./docs

生成目录如下：

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

docsify 启动

本地启动

docsify serve docs

Docsify高级特性

docsify的配置

window.$docsify = {
      name: '研发中心',
      repo: 'https://git.git',
      loadNavbar: true,
      loadSidebar: true, // 加载自定义侧边栏
      maxLevel: 2, // 默认情况下会抓取文档中所有标题渲染成目录，可配置最大支持渲染的标题层级。
      subMaxLevel: 4, // 生成目录的最大层级
      mergeNavbar: true, // 小屏设备下合并导航栏到侧边栏
      alias: { // 定义路由别名，可以更自由的定义路由规则。 支持正则
        '/.*/_sidebar.md': '/_sidebar.md',//防止意外回退
        '/.*/_navbar.md': '/_navbar.md'
      }
    }

动态生成目录

获取代码

执行自动生成命令

会增加_siderbar.md

执行后

运行效果

获取代码

欢迎关注,回复“docsify”，获取免费获取源码下载地址；

js参考手册

上一篇：Qt/C++最新地图组件发布/历时半年重构/同时支持各种地图内核
下一篇：20多张欠条，他还了8年（20年的欠条）

Docsify-3分钟搭建属于自己的技术文档WIKI

特性

相关推荐

django留言板_留言板html好看的模板

你还在手动筛选吗?filter函数才是多条件筛选的yyds!

一次分享给你29个PHP基础常用类助力你快速提升

一篇文章轻松掌握VLookup、XLookup与Filter函数

软件工程培训，选择线上还是线下呢?

连南举办2024年软件正版化工作联席会议暨正版软件培训班

初学ThinkPHP(一):用TP6+LayUI实现数据表格

新函数FILTER函数_filter函数的作用

营商在上海_营商上海数字科技有限公司

Excel筛选也智能?一个FILTER函数就搞定!