slate

slate

v2.3.1 Beautiful static documentation for your API https://spectrum.chat/slate

Beautiful static documentation for your API https://spectrum.chat/slate

slate

功能介绍

Slate helps you create beautiful, intelligent, responsive API documentation.
只需要将自己的API利用markdown编写,或将现有的API从平台或测试工具导出为markdown格式存放在slate项目中即可。

安装使用

helm install myslate slate

运行后看到输出:

# git clone https://github.com/cloudnativeapp/charts.git
# git checkout tag_name
# cd submitted/slate
# helm install myslate slate/
NAME: myslate
LAST DEPLOYED: 2019-08-16 15:27:52.369424716 +0800 CST m=+0.129371478
NAMESPACE: default
STATUS: deployed

NOTES:
1. Get the application URL by running these commands:
  export NODE_PORT=$(kubectl get -o jsonpath="{.spec.ports[0].nodePort}" services myslate)
  export NODE_IP=$(kubectl get nodes -o jsonpath="{.items[0].status.addresses[0].address}")
  echo http://$NODE_IP:$NODE_PORT
  

# kubectl get pods
myslate-7ccbf64fff-b6rds                                  1/1     Running     0          74s

# kubectl get deploy
myslate                                  1/1     1            1           3m10s

# kubectl get svc
myslate                             NodePort    10.96.128.97     <none>        4567:30568/TCP                                          2m4s

执行完 NOTES 中提示命令的命令即可在浏览器中访问 http://$NODE_IP:$NODE_PORT 查看。

效果示例

Screenshot of Example Documentation created with Slate

The example above was created with Slate. Check it out at lord.github.io/slate.

  • 安装

    Add repository

    helm repo add experimental https://apphub.aliyuncs.com/experimental

    Install chart

    helm install experimental/slate --version v2.3.1
    一键安装
  • Chart 版本

    v2.3.1
  • App 版本

    v2.3.1
  • 主页