文档

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

该仓库基于Mintlify框架，内容采用Markdown格式。更多详情，请参阅Mintlify文档。

环境搭建

1. 安装最新长期支持版本的Node.js。

2. 安装Vale。

3. 安装Mint CLI。

4. 分叉此仓库并克隆它。更多详情，请参阅GitHub文档。

5. 在终端运行以下命令以同步Vale样式包。

   vale sync
   

可选：安装以下VS Code扩展：

• Code Spell Checker
• MDX
• Vale VSCode

本地构建

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

mint dev

检查断链

在终端运行以下命令以检查断链：

mint broken-links

确保风格一致

在终端运行以下命令以检查文件的风格：

vale example.mdx

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

vale .

贡献

我们重视您的意见，并邀请您帮助我们使Axiom文档更加完善。以下是您可以参与的方式：

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

故障排除

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