crestalnetwork/docs

欢迎来到 Crestal Docs 仓库！本开发文档旨在引导开发者集成 Crestal 的工具和 API。

入门指南

前置要求

在本地运行此文档之前，请确保已安装以下工具：

1. Node.js - 点击此处下载
2. Yarn - 安装 Yarn
3. Mintlify CLI - 通过 npm 安装 Mintlify：

   npm install -g mintlify
   

本地设置

按照以下步骤使用 Mintlify 在本地设置并运行 Crestal Docs：

1. 克隆仓库

克隆 Crestal Docs 仓库并进入项目目录：

git clone https://github.com/crestalnetwork/docs.git
cd docs
cd mintlify-docs

2. 安装依赖

使用 Yarn 安装项目依赖：

yarn install

4. 运行 Mintlify 开发服务器

使用 Mintlify CLI 在本地运行文档服务器：

mintlify dev

服务器将在 http://localhost:3000 启动，您可以在此实时查看并编辑文档。

5. 构建生产版本（可选）

如果您需要生成生产环境就绪的构建版本，请使用：

mintlify build

此命令将在 dist 文件夹中创建文档的静态输出，可直接用于部署。

贡献指南

我们欢迎任何形式的贡献！开始贡献的步骤如下：

1. Fork 仓库：Fork https://github.com/crestalnetwork/docs.git 并克隆到本地。

2. 创建分支：为您的修改创建新分支：

git checkout -b feature/your-feature-name

3. 进行修改：编辑文档并使用以下命令进行预览：

mintlify dev

4. 提交并推送：提交您的更改并推送到您的 Fork 仓库：

git add .
git commit -m "Brief description of your changes"
git push origin feature/your-feature-name

5. 发起 Pull Request：向原始仓库的主分支提交 Pull Request。

感谢您的贡献！