文件名称:libopenstorage.github.io:https的内容
文件大小:11.46MB
文件格式:ZIP
更新时间:2024-06-03 23:22:22
HTML
OpenStorage API网站
这将存储的源代码和输出。 该网站是使用创建的。 所有的源代码和降价文件都在docs目录中。 gitbook创建的输出html位于w目录中。
环境设定
首先,您可能需要安装 。 然后安装gitbook:
$ npm install -g gitbook-cli
建立:
make
要在编辑时在http://localhost:4000上本地提供服务,请运行:
make serve
生成API文档
要生成它,您将需要安装
然后键入make api生成API文档。
发行
发布新版本时,请使用以下方法在文档网站上维护该发布版本:
在getcontent.sh添加一个条目
编辑reference.md.tmpl
在docs/SUMMARY.md中的引用中添加一个条目
创建docs/swagger-ui/