SuperAPI AI 工具集

docsify

部署与运维

查看项目

更新于 10-15 23:32

技能介绍

用途:本技能用于指导构建、配置、定制和部署 Docsify 文档站点。Docsify 在运行时把 Markdown 文件渲染为文档网站,没有静态构建步骤;一个 index.html 启动 docsify.js,动态抓取并渲染 .md 文件。

主要能力:覆盖新建站点与 index.html 编写、docsify-cli 用法、页面与 _sidebar.md/_navbar.md/_coverpage.md 导航、多语言布局、目录、window.$docsify 配置项、Docsify 特有 Markdown 语法(提示块、链接/图片属性、标题 ID、:include 嵌入、代码高亮)、主题切换与 CSS 变量、内置与社区插件、自定义插件生命周期钩子,以及 GitHub Pages、GitLab、Netlify、Vercel、Firebase、Docker、Nginx、AWS Amplify 等部署方式,另含 PWA/离线、虚拟路由、Vue 组件与 v4 到 v5 升级。

使用方式:站点只需三样东西——index.html(加载 docsify.js、主题 CSS、可选插件并定义 window.$docsify)、Markdown 文件(README.md 为首页,其他 *.md 为路由)、可选下划线文件(_sidebar.md、_navbar.md、_coverpage.md、_404.md、_media/、.nojekyll)。本地可用 docsify serve <folder> 或 python3 -m http.server 验证。按任务只加载所需参考文件,不要预加载全部。

限制与注意:默认面向 Docsify v5,v5 目前仅发布候选版 5.0.0-rc.4,CDN 需固定该版本或使用 docsify@rc;稳定版发布前 docsify@5 简写无法解析,长期稳定线用 docsify@4(CDN 路径 /lib/ 而非 /dist/)。主题 CSS 必须在 Docsify JS 之前,主题附加项在核心主题之后,Prism 与插件脚本在 docsify.min.js 之后。GitHub Pages 使用任何 _*.md 文件时必须加 .nojekyll。默认哈希路由,仅当主机能重写 URL 到 index.html 时才用 routerMode: 'history'。Mermaid 仅支持同步版本(≤ v9.3.0)。v5 中旧式 !> / ?> 提示块与 themeColor/topMargin 已弃用。