Files
snowy-yang bcd69099b6 docs: 文档模块化重构(guide/api 多页),文档站迁移 GitHub Pages Actions 部署
GUIDE/API 拆为 docs/guide/ 五页与 docs/api/ 七页,侧边栏分组折叠,
旧链接 alias 映射;安装改为 pip install qqbotsdk-py,README 加徽章;
删除 docs 分支同步工作流,pages.yml 直部署(自定义域名 CNAME 随产物带上)。
2026-10-03 19:12:11 +08:00

101 lines
4.2 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>qqbotsdk 文档</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="QQ 官方机器人 Python SDK:使用指南、API 参考、架构设计与示例">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@4/themes/vue.css">
<style>
/* mermaid 图居中并自适应宽度 */
.markdown-section .mermaid {
text-align: center;
}
.markdown-section .mermaid svg {
max-width: 100%;
height: auto;
}
</style>
</head>
<body>
<div id="app">加载中…</div>
<script>
window.$docsify = {
name: 'qqbotsdk',
repo: 'https://github.com/snowy-yang/qqbotsdk',
// 相对链接按当前页面所在目录解析(与 GitHub 行为一致),docs/*.md 的互链才能正确跳转
relativePath: true,
loadSidebar: true,
// 侧边栏分组("使用指南"/"API 参考")默认展开一级
sidebarDisplayLevel: 1,
subMaxLevel: 3,
auto2top: true,
themeColor: '#0f8bff',
search: {
paths: 'auto',
placeholder: '搜索文档',
noData: '没有找到相关结果',
depth: 3,
},
copyCode: {
buttonText: '复制',
errorText: '复制失败',
successText: '已复制',
},
pagination: {
previousText: '上一页',
nextText: '下一页',
},
// README 里的 examples/ 链接指向示例索引页
alias: {
'/examples': '/examples/README.md',
'/examples/': '/examples/README.md',
// 子目录页面的 _sidebar.md 请求映射到根目录的:
// docsify 会先请求 <当前目录>/_sidebar.md,而 Cloudflare Pages 对
// 缺失文件回退 index.html 且状态 200,docsify 误当作侧栏解析导致目录空白
'/docs/_sidebar.md': '/_sidebar.md',
'/examples/_sidebar.md': '/_sidebar.md',
// 文档模块化重构(GUIDE/API 拆为 guide/ 与 api/ 多页)后的旧链接映射
'/docs/GUIDE.md': '/docs/guide/start.md',
'/docs/API.md': '/docs/api/core.md',
},
plugins: [
// 把 ```mermaid 代码块替换为 div 后交给 mermaid 渲染(架构图/时序图)
function (hook) {
hook.doneEach(function () {
var blocks = document.querySelectorAll('pre code.lang-mermaid, pre code.language-mermaid');
if (!blocks.length || !window.mermaid) return;
blocks.forEach(function (el) {
var pre = el.closest('pre') || el;
var div = document.createElement('div');
div.className = 'mermaid';
div.textContent = el.textContent;
pre.replaceWith(div);
});
mermaid.run({ querySelector: 'div.mermaid:not([data-processed])', suppressErrors: true });
});
},
],
};
</script>
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
<!-- 侧边栏分组折叠(需在 docsify 之后引入) -->
<script src="https://cdn.jsdelivr.net/npm/docsify-sidebar-collapse@1.3.5/dist/docsify-sidebar-collapse.min.js"></script>
<!-- prism 语言包需在 docsify 之后引入(docsify 会重建 window.Prism,先加载会被覆盖) -->
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-python.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-toml.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-bash.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-ini.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code@3/dist/docsify-copy-code.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-pagination@2/dist/docsify-pagination.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
<script>
mermaid.initialize({ startOnLoad: false, securityLevel: 'loose' });
</script>
</body>
</html>