SuperAPI AI 工具集

tanstack-markdown-docs-features

前端与建站

查看项目

更新于 10-16 00:02

技能介绍

用途:该技能基于 render-markdown,用于为 TanStack Markdown 构建文档元数据与自定义元素,适合生成文档站点的解析与渲染流程。

主要能力:docsMarkdownExtensions() 预设组合了提示块(callouts)、转换后的注释组件和标题收集。它输出元数据和自定义元素,但不安装文档 UI 行为。支持多种标签页变体:标题标签页按最浅标题切分;文件标签页选取围栏代码块并以 title= 或 file= 作为标签;包管理器标签页消费 framework: package... 行并在创建元数据后移除源子节点;打包器标签页仅接受 Vite 与 Rsbuild 标题段。框架块要求一级选择器标题,输出 md-framework-panel 子节点。

使用方式:创建扩展数组并同时用于解析与渲染。示例:const extensions = docsMarkdownExtensions(); const document = parseMarkdown(source, { extensions }); renderHtml(document, { extensions, headingAnchors: true })。标题收集默认跳过名为 tabs 的组件内所有标题,可用 docsMarkdownExtensions({ collectHeadings: false }) 禁用,或用 skipComponentNames 替换默认跳过集。组件元数据存放在 ComponentNode.properties 的字符串中,含 JSON 的值需由消费应用自行解析。

限制:转换只提供模型和自定义元素名,交互行为需站点自行绑定状态与控件;未匹配的 start 会被当作空组件消费;文件变体找不到直接代码块子节点时静默返回原组件;围栏元数据只填充 AST 和高亮选项,分词、主题与 CSS 不在此包内;不执行 MDX、JSX 或 JavaScript 表达式;高亮输出为受信 HTML,应在构建时或服务端进行。