#文档贡献指南

#快速开始

阅读仓库 README.md 了解如何进行开发、目录结构等。

#编写文档

#中英文混排

• 中文文档请使用全角标点符号，英文文档请使用半角标点符号
• 中英文/数字混合请在中英文/数字字符之间添加空格

You should use half-width symbol in English paragraph.
这是一篇 ReactLynx 3 的文档。

#代码

• 文本中的代码插值请使用 `` 包裹
• 整段的代码块请使用 ``` 编程语言包裹

专有名词

对于 Lynx Engine, ReactLynx, Rspeedy 等专有名词，

• 不要使用代码块包裹
• 使用正文使得其可以被百科索引，或使用超链接索引到相关源（比如术语表）

#框架特定内容

有多种方式可以为选定的框架定制文档内容。

• 对于特定于框架的片段内容，可以使用 <DSLContent> 组件。请参考文档组件了解更多信息。
• 对于整个文档，可以使用 context 元数据来根据上下文条件化侧边栏中内容的可见性，并为文档添加徽章。请参考文档上下文了解更多信息。
• 对于整个文档中使用的编程语言，如果需要组件内语法高亮代码块支持，请在文档编程语言验证中补齐并验证。

#特定内容

在文档中添加特定的内容时，可以在目录或者文档中使用 context: custom-context 进行标记，请参考文档上下文了解更多信息。

#添加可交互示例

我们推荐在文档站仓库中维护示例以保持文档与示例同步，并方便更新。请参考 lynx-examples/README.md

#文档组件参考

在 ./src/components/ 下预定义了几个文档组件，以提升编写和使用文档的体验。 你可以在这里查看它们。

#文档上下文参考

文档上下文（context）是一个用于管理和显示不同类型文档的标记系统。通过在文档元数据中设置上下文标记，可以为文档添加诸如根据上下文隐藏、显示特定的标识徽章（Badge）等效果。 请参考文档上下文了解如何使用。