文档协作平台

欢迎来到Axiom 文档仓库它包含了下面的一切 axiom.co/docs 子路径。这是一个开放供反馈和贡献的协作空间。

该仓库基于Mintlify框架，内容采用Markdown格式。有关更多信息，请参见 Mintlify文件.

设置

1. 安装最新的LTS版本 Node.js.

2. 安装 谷、山谷.

3. 安装 Mint CLI.

4. 分叉此仓库，然后克隆它。有关更多信息，请参阅 GitHub文档.

5. 在终端中运行以下命令以同步Vale风格的软件包。

   复制

   vale sync
   

可选：安装以下VS代码扩展：

• 代码拼写检查器
• MDX
• 淡水河谷VSCode

本地建设

在终端中运行以下命令以在本地构建文档：

mint dev

检查断开的链接

在终端中运行以下命令以检查断开的链接：

mint broken-links

确保风格一致

在终端中运行以下命令以检查文件的样式：

vale example.mdx

在终端中运行以下命令，检查当前文件夹及其子文件夹中所有文件的样式：

vale .

贡献

我们重视您的意见，并邀请您帮助我们改进Axiom文档。以下是您如何参与其中：

1. 评分页面。点击👍/👎 任何页面上的按钮，让我们知道你喜欢什么和不喜欢什么。
2. 留下反馈。点击 提出问题 在任何文档页面上创建一个GitHub问题，您可以在其中分享想法和建议。
3. 建议编辑。发现拼写错误或信息过时？点击 建议编辑 直接在页面上。
4. 贡献内容。如果你有深入的知识或独特的用例，我们鼓励你通过撰写新章节或增强现有章节来做出贡献。在投稿之前，请阅读 贡献指南 和那个 贡献者契约.

故障排除

• 如果本地构建失败，请运行 mint update.
• 如果页面以404加载，请确保在文件所在的根文件夹中运行本地构建 docs.json 存在。