跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.nexfi.robert.dpdns.org/llms.txt

Use this file to discover all available pages before exploring further.

​
本地开发

​
前置条件

  • 已安装 Node.js
  • 本地具备 mintlify/ 目录

​
启动本地预览

在 mintlify/ 目录中运行： 
mint dev
如果没有全局安装 CLI： 
npx mint dev
默认地址： 
http://localhost:3000

​
常用预览参数

自定义端口： 
mint dev --port 3333
禁止自动打开浏览器： 
mint dev --no-open

​
文件结构

主配置文件： 
mintlify/docs.json
说明页目录： 
mintlify/wallet/
mintlify/bridge/
mintlify/staking/
mintlify/quant/
mintlify/zh/wallet/
mintlify/zh/bridge/
mintlify/zh/staking/
mintlify/zh/quant/
OpenAPI 目录： 
mintlify/openapi/
mintlify/openapi/zh/

​
文档维护规则

当新增或修改接口时，建议同时更新三层：
  1. OpenAPI 文件 更新 schema、字段说明、请求体、响应体和示例。
  2. MDX 说明页 更新接口用途、参数表、返回字段表和业务说明。
  3. 导航配置 如果页面新增、改名或调整分组，需要同步修改 mintlify/docs.json。

​
双语维护规则

当前站点不是一套内容自动翻译成两种语言，而是分别维护：
  • 英文说明页单独维护
  • 中文说明页单独维护
  • 英文 OpenAPI 单独维护
  • 中文 OpenAPI 单独维护
因此，接口变更时应至少检查以下对应文件：
  • 英文说明页
  • 中文说明页
  • 英文 OpenAPI
  • 中文 OpenAPI
例如 Wallet 资产接口变更时，需要关注： 
mintlify/wallet/config-assets.mdx
mintlify/zh/wallet/config-assets.mdx
mintlify/openapi/wallet.openapi.yaml
mintlify/openapi/zh/wallet.openapi.yaml

​
新增接口推荐流程

  1. 先在模块 OpenAPI 中新增或修改接口。
  2. 立即补全字段说明和示例。
  3. 更新对应英文 MDX 页面。
  4. 更新对应中文 MDX 页面。
  5. 如需中文 API Reference 正常显示，再同步更新中文 OpenAPI。
  6. 本地预览后分别抽查英文和中文页面。

​
官方参考