@ clean-jsdoc-主题/ setu
JSDoc – SiteManifest (英语). 验证一个咸的多克乐收藏,走走
可记录类型,并释放结构 SiteManifest 矮人会消耗.
0渲染知识——没有HTML,没有JSX,没有文件一/O.
完整的模块图、分层规则和更广泛的管道见
转帐 docs/ARCHITECTURE.md。 。 。 .
公共 API
import { generateSite } from '@clean-jsdoc-theme/setu';
import type { SiteManifest } from '@clean-jsdoc-theme/utils';
const manifest: SiteManifest = generateSite(saltyCollection, {
pkg: { name: 'my-lib', version: '1.0.0' },
readme: readmeHtml, // optional: rendered to the home page
tutorials: tutorialTree, // optional: rendered as guide pages
sources: sourceFiles, // optional: rendered as source-viewer pages
});
generateSite(collection, opts?) 列出每个记录的容器符号,
生成一个 Page 每个符号(前题、MDX正文、斜体 URL,
按类型组合导航,并返回完整
SiteManifest 准备向 dwar.render。 。 。 .
遗产入境点
import { generateMdx } from '@clean-jsdoc-theme/setu';
const bodies: string[] = generateMdx(collection);
一个薄的相容性包装器,它从它的数组物理字符串中产生
generateSite. 偏爱 generateSite 新代码.
低级助手
用于要检查或生成的工具的作曲部件导出 单个页面 :
buildContainerPage(collection, longname, kind, sourceLink?, resolveLink?)- 一个集装箱符号-一个Page。 。 。 .buildGlobalsPage(collection, …)——汇总全局页面(或null) (中文(简体) ).enumerateLongnamesByKind(collection, kind)一种独特的有文献记载的长名.extractHeadings(tree)- 目标Root→Heading[]上面写着"身份证明".buildNav(pages), (中文(简体) ),computeBuildId(pages), (中文(简体) ),splitLongnameForSlug(longname)。 。 。 .buildReadmePage, (中文(简体) ),buildTutorialPages, (中文(简体) ),buildSourceModel——出道人/出道人表面.
种类参数管道(getContainerView, (中文(简体) ), containerViewToMdast,则
mdast 构造器)是从同一个表面导出. 阶级时代的名称
(单位:千美元)buildClassPage, (中文(简体) ), enumerateClassLongnames, (中文(简体) ), getClassView, (中文(简体) ), classViewToMdast(中文(简体) )
作为细的别名.
覆盖范围
setu使这5个集装箱类型—— 类、接口、混音、模块、, 命名空间 通过一种参数路径(类保持其构造器) params special special; 阶级/界面行走继承链. 除此之外:
- 类型def 页面.
- 合计 全球 用于不拥有页面的全球范围符号的页面.
- 事件/ 提示/ 常数 在其母页内作为成员章节.
- 项目 读取 成为主页; 教程 成为指导页; 文档 源文件 成为只读取的浏览器页面.
- A 类 文件目录 (单位:千美元)
opts.docsMarkdown/HTML——文件系统布局(加) 可选的 YAML 前题)驱动弹出和侧边栏组. - 点名、步骤、标签和嵌入 低于资本化的 MDX JSX 节点
(单位:千美元)
<Callout>编号 :<Steps>编号 :<Tabs>编号 :<Embed>转来转去 组件;@iframe标签和```iframe栅栏共享一个配置语法. - i18n 槽数 ——每个可变字符串(描述,摘要,示例)
标题、参数/返回描述)
SlotEntry阿迪什给 翻译stampSite重新交代一个有译名的地方.
链接分辨率
{@link} 编号 : {@linkcode} 编号 : {@linkplain} 财务报告和审定财务报表 @see 重写为真实
锚. 每个生成的页面(及其成员)先用双通式编成登记册
然后将每个有解析器的页面关闭,这样
ưμ㼯A 一个名道姓的人决定
符号的 sattle (+ a) #member 标题主机);外部 URLs 直接链接;
未解决的命名路径返回到内置代码 .
管道安装
salty collection ──► setu.generateSite ──► SiteManifest ──► dwar.render ──► HTML/CSS/JS
▲ ▲
│ │
schema + slug rules components from
@clean-jsdoc-theme/utils @clean-jsdoc-theme/rang
堵塞规则( :slugifyHeading 编号 : slugifyPath住在这里 @clean-jsdoc-theme/utils
并被 setu(侧边栏/ TOC 生成) 和 dwar( 已放弃标题) 使用
锚. 相同的规则 – 匹配两侧的锚.
贡献者
感谢所有帮助建立干净的jsdoc主题的人.
许可证
麻省理工学院.