TEM 对应的用户指南文档和 OpenAPI 文档

项目结构


tem_book                                     
├─ assets   -- 静态资源文件夹                          
│  └─ logo_icon.svg                          
├─ openapi   --  openapi 文档分类的 md 文件                         
├─ pdf    -- 用于生成 pdf 的单个完整的 markdown 文档文件夹                                
│  ├─ tem_deployment_guide.md  -- 部署指南         
│  ├─ tem_openapi.md           -- OpenAPI 文档             
│  └─ tem_user_guide.md        -- 用户指南文档
├─ singlecluster    -- 单个集群用户指南                                              
├─ SUMMARY.md       -- 文档页面目录结构                                            
├─ book.json        -- 项目依赖                        
├─ introduce.md     -- 项目简介                        
├─ logo.svg                                                       
└─ userguide.md     -- 用户指南

项目运行

gitbook serve

执行完命令可在 http://localhost:4000 查看生成的页面

项目打包

gitbook build

build 完成后会在项目里生成个 _book 的文件夹, 为打包后的静态页面文件.

© 2024 平凯星辰(北京)科技有限公司 all right reserved,powered by GitbookFile Modify: 2024-04-02 15:37:04

results matching ""

    No results matching ""