Skip to content

Loopring/DEX-API-V3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

87b17d7 · Apr 5, 2023
Apr 5, 2023
Mar 2, 2022
Dec 29, 2020
Mar 2, 2022
Apr 4, 2020
Jun 11, 2022
Feb 29, 2020
Mar 25, 2020
Dec 25, 2020
Aug 19, 2022
Jan 11, 2022
Mar 2, 2022
Dec 28, 2020
Dec 17, 2020
Oct 28, 2021
Dec 24, 2020
Jun 25, 2021
Oct 28, 2021

Repository files navigation

DEX-API

Loopring 文档。

准备

安装 node.js

https://nodejs.org/en/

安装 gitbook

npm install gitbook-cli -g
gitbook fetch

安装Jinja2

pip install Jinja2

gitbook 手册

https://chrisniael.gitbooks.io/gitbook-documentation/content/ https://docs.gitbook.com/

本地写文档

如果是第一次使用,需要运行下面命令:

./xdoc.py refresh build
cd generated
gitbook install
gitbook serve

之后访问下面的链接即可看到文档: http://localhost:4000/

以后在编写完文档后,只需要运行 ./xdoc.py build 命令即可:

./xdoc.py build

页面会自动刷新。

如果API swagger的定义发生了变化,可以用下面的命令更新:

./xdoc.py refresh

如果编辑非Restful API部分,可以忽略refresh命令(使用meta目录下默认的文件)。

如果gitbook server挂了,重新运行即可:

gitbook serve

gitbook install 命令用来安装插件,一般来说运行一次即可。除非您配置了新的插件。

** 确保您的gitbook命令运行在 generated 目录下。 **

I18N

需要完成以下三部分内容的翻译:

  • tpl/en 目录下所有文件的翻译
  • i18n 目录下messages.en文件的翻译
  • 完成gateway(play framework)的i18n: 将 gateway/conf/messages.zh 的内容翻译后放到 gateway/conf/messages 中。

发布文档

执行:

./publish.sh

文档会发布到下面的页面: https://loopring.github.io/DEX-API-V3/ https://docs.loopring.io

自动部署

目前该文档是有王东在Vercel平台上自动部署的,部署使用的分支是v3-draft,部署过程假设docs目录已经生成完善。也就是说部署过程其实不运行任何命令行来更新文档。