文档
生成精美的交互式文档网站
可重复使用的片段
使用单一来源保持您的文档 DRY(Don’t Repeat Yourself):定义一次可重复使用的 Markdown 片段,然后在多个地方引用它。这样,您只需要在一个地方更新片段即可保持所有引用同步。
可重复使用的片段适用于常量(API 限制、订阅价格、版本号)、重复的警告或注释以及标准化格式块。
在您的 fern 项目的任意位置创建一个名为 snippets 的文件夹。在 snippets 文件夹内,为您想要定义的每个片段创建一个新的 Markdown 文件。
fern
snippets
在每个片段文件中,定义您想要重复使用的内容。
1Peace lilies are easy to grow and relatively trouble-free.
为了使片段更加灵活,您可以使用参数(也称为变量)。参数使用 {{parameterName}} 语法,可以放在片段内容的任何位置。
{{parameterName}}
1<Warning>Remember to water your {{plant}} every {{interval}} days.</Warning>
然后,您可以在每次使用片段时为这些参数传递不同的值。
要在您的文档中使用片段,请通过其文件路径(包括 .mdx 扩展名)引用它。如果您在片段中使用了参数(变量),请为每个参数传递值:
.mdx
1<Markdown src="/snippets/peace-lily.mdx">23They symbolize peace and prosperity.45<Markdown src="/snippets/watering-schedule.mdx" plant="peace lily" interval="3">
src 路径是以 fern 文件夹为根目录的绝对路径。无论您从哪个页面引用,路径都是相同的:
src
fern/snippets/peace-lily.mdx
src="/snippets/peace-lily.mdx"
fern/docs/snippets/peace-lily.mdx
src="/docs/snippets/peace-lily.mdx"
fern/docs/guides/snippets/peace-lily.mdx
src="/docs/guides/snippets/peace-lily.mdx"