Skip to content
On this page

开始

此部分是为了帮助您更好的了解本文档构成而编写。

建议您在开始编写文档之前,先花几分钟阅读完此部分。

牛搭文档模块主要分为三个大类,也就是右上角所见到三个入口 指南开发文档

指南部分

此部分主要面向于 使用者,而 不是 开发者。因此在该部分请不要或者尽量少提及开发相关的术语、链接等。

提示

下面是 不正确 的示例

  • 可以参阅 Vant 中 Swipe 组件的 props 进行配置

开发部分

此部分就是面向于有阅读或编写牛搭源代码需求的开发人员而编写。该部分的编写应该详略得当,必要时请插入有关文章、代码进行说明。

可以对于较为细节的部分建议使用 vitepress 的自定义容器功能。编写方式请看下面的演示。

这里是标题

这里是说明文字

// 这里是上面演示对应的书写格式
::: details 这里是标题
这里是说明文字
:::

文档部分

此部分就是您现在所见到的部分。该部分面向于编写文档的作者进行说明一些细节上的要求。