TypeDoc项目实现无侧边栏API文档输出的技术方案

在TypeDoc文档生成工具的实际应用中，有时我们需要将API文档嵌入到其他页面中展示，这时往往希望隐藏侧边栏等导航元素，只保留核心内容。本文将详细介绍如何在TypeDoc中实现这一需求。

需求背景

在技术文档开发中，我们经常需要将API参考文档集成到主文档系统中。例如，在讨论某个类时，希望直接将该类的定义嵌入到页面中，而不显示整个文档站点的导航结构。这种"纯净"的API文档输出方式有助于保持主文档的连贯性和专注性。

技术实现方案

TypeDoc本身不提供直接隐藏侧边栏的配置选项，但我们可以通过以下两种方式实现这一需求：

方案一：自定义主题（推荐用于单一输出模式）

通过创建自定义主题来覆盖默认的导航和侧边栏渲染方法：

1. 继承默认主题并重写相关方法
2. 在navigation和pageSidebar方法中返回空内容
3. 调整布局样式以适配单栏显示

这种方案适合只需要单一输出模式的场景，实现较为彻底且性能更优。

方案二：动态切换方案（推荐需要两种模式的场景）

对于既需要完整文档又需要纯净API输出的场景，可以采用动态切换方案：

1. 添加查询参数检测脚本：通过插件注入JavaScript代码，检测URL中的特定参数
2. 设置文档状态标记：当检测到参数时，在文档根元素上设置自定义属性
3. 编写条件样式：基于自定义属性控制不同元素的显示/隐藏

具体实现代码如下：

插件脚本：

const { JSX } = require("typedoc");

exports.load = function load(app) {
    app.renderer.hooks.on("head.begin", () => {
        return JSX.createElement("script", null,
            JSX.createElement(JSX.Raw, { 
                    html: `const urlParams = new URLSearchParams(window.location.search);
                           if (urlParams.get('sidebars') === 'false') { 
                            document.documentElement.setAttribute('data-sidebars', 'false'); 
                            }`
            }))
    });
}

CSS样式：

html[data-sidebars='false'] .tsd-page-toolbar {
    display:none;
}

html[data-sidebars='false'] .col-sidebar {
    display:none;
}

html[data-sidebars='false'] .container-main {
    grid-template-columns: minmax(0, 100vw);
    grid-template-areas:
            "content";
}

使用方式

配置完成后，可以通过以下方式生成文档：

npx typedoc --plugin my-plugin.js --customCss my-css.css [其他参数]

访问文档时：

• 完整文档：直接访问页面URL
• 纯净API输出：在URL后添加?sidebars=false参数

方案比较与选择建议

1. 自定义主题方案：

   • 优点：性能更好，实现更彻底
   • 缺点：需要维护两套文档输出
   • 适用场景：只需要纯净API输出的情况

2. 动态切换方案：

   • 优点：一套文档支持两种查看模式
   • 缺点：需要加载额外脚本和样式
   • 适用场景：需要同时支持两种查看模式的场景

扩展思考

这种技术方案不仅适用于TypeDoc，类似的思路也可以应用于其他文档生成工具。关键在于理解文档生成工具提供的扩展机制，以及如何利用前端技术实现动态样式切换。

对于更复杂的需求，还可以考虑：

1. 通过iframe参数自动控制显示模式
2. 添加打印样式优化打印输出
3. 集成到文档构建流程中自动生成两种版本

通过这种灵活的文档展示控制，可以显著提升技术文档的用户体验，特别是在将API参考集成到教程和指南文档中的场景。