Ultdocs

目前处于实验阶段

简介

这最终将是一个针对三个用例的静态网站生成器，具有交互式代码

• Postman 集合
• Markdown 文档
• OpenAPI

由于没有很好的替代品，发布 Postman 集合是首要任务。

静态网站

使用 Svelte、TailwindCSS 和 Vite 生成网站，允许热重载，文件夹和请求都应用了类，样式通过 Tailwind 指令在 app.css 文件 中控制。

配置

config.yaml 可在仓库根目录中更改，以允许通过 Postman API 获取远程 Postman 集合，例如。

获取您的 Postman API 密钥

通过单击其名称旁边的三个点并单击 设置 获取您的集合 ID

collection_from_api: true
postman_api_key: "XXXXX-XXXXX-XXXXX-XXXX"
collection_id: "XXXXXXX-XXXXXXXXX-XXXXXXXXX-XXXXXX"

您可以通过在配置文件夹中放置新文件来覆盖基本 config.yaml，例如。

• Linux /home/alice/.config/ultdocs/config.yaml
• MacOS /Users/Alice/Library/Application Support/ultdocs/config.yaml
• Windows C:\Users\Alice\AppData\Roaming\ultdocs\config.yaml