@ graphql- markdown/ 格式化
事务预设框架 图QL- 马可达。 。 。 .
该套件为通俗文献框架提供现成的物料预设,每个物料都在自己的套件子路径中.
安装
npm install @graphql-markdown/formatters
使用量
使用您的 GraphQL- Markdown 配置中的任何预设 :
schema: ./schema.graphql
extensions:
graphql-markdown:
rootPath: ./docs
baseURL: api
formatter: "@graphql-markdown/formatters/docusaurus"
或在方案方面:
import { runGraphQLMarkdown } from "@graphql-markdown/cli";
await runGraphQLMarkdown({
schema: "./schema.graphql",
rootPath: "./docs",
baseURL: "api",
formatter: "@graphql-markdown/formatters/docusaurus",
});
遗产 mdxParser 设置仍然作为已贬值的别名起作用,但新配置应当使用 formatter。 。 。 .
支持的格式符
每个论坛都有自己的设置指南:
| 框架 | 软件包路径 | 文档 |
|---|---|---|
| 天体星光 | @graphql-markdown/formatters/starlight | 指南 |
| 文档FX | @graphql-markdown/formatters/docfx | 指南 |
| 多龙 | @graphql-markdown/formatters/docusaurus | 指南 |
| 亲爱的 | @graphql-markdown/formatters/honkit | 指南 |
| 乌戈 | @graphql-markdown/formatters/hugo | 指南 |
| 微书 | @graphql-markdown/formatters/mdbook | 指南 |
| 常规 MDX | @graphql-markdown/formatters/mdx | 指南 |
| 麦克风 | @graphql-markdown/formatters/mkdocs | 指南 |
| 下一个.js + Fumadocs | @graphql-markdown/formatters/fumadocs | 指南 |
| 声音 | @graphql-markdown/formatters/vocs | 指南 |
自定义处理
对于上面没有列出的框架,创建自定义的MDX模块. 见 融合指南 全部物料合同 formatMDXDetails \r 指定词不变量,以及扩展预设的例子.
文档
捐款
添加新主题
- 在
src/<name>/index.ts。 。 。 . - 创建文档于
src/<name>/README.md。 。 。 . - 导出前题
src/index.ts。 。 。 . - 添加包子路径导出
./<name>内package.json下级exports。 。 。 . - 在其中添加单位测试
tests/unit/<name>/index.test.ts。 。 。 .
Formaters 合同
一个 formatter 模块导出 createMDXFormatter 和任何关于物质函数的标准子集(formatMDXBadge, (中文(简体) ), formatMDXAdmonition, (中文(简体) ), formatMDXBullet, (中文(简体) ), formatMDXDetails, (中文(简体) ), formatMDXFrontmatter, (中文(简体) ), formatMDXLink, (中文(简体) ), formatMDXNameEntity, (中文(简体) ), formatMDXSpecifiedByLink) (中文(简体) ). 可选出口包括: mdxDeclaration, (中文(简体) ), mdxExtension和生命周期钩.
见 融合指南 合同全文、类型签名和 formatMDXDetails \r 划界者无常.
测试清单
添加验证测试 :
- 用于代表性投入的每个格式函数输出.
createMDXFormatter返回所有需要的材料方法.- 框架特定的行为和边缘案例(例如链接扩展映射,前事行为,空标题倒置等).
开发目标测试时:
cd packages/formatters
bun run test:unit -- tests/unit/<name>/index.test.ts
在打开 PR 之前运行套件检查 :
cd packages/formatters
bun run lint
bun run prettier
bun run test:unit
全库验证:
cd /path/to/graphql-markdown
bun run test
许可证
GraphQL-Markdown 软件包是100%的自由和开源软件,在 麻省理工学院许可证。 。 。 .
这个软件包是 树件如果你把它用于生产,那么我们要求你 给世界买一棵树 感谢我们的工作。 通过为"树地"森林做贡献,你们将为当地家庭创造就业机会并恢复野生动物栖息地.