1 unstable release
0.1.1 | Jan 23, 2022 |
---|
#20 in #postman
66KB
861 lines
Ultdocs
Currently in experimentation phase
Intro
This will eventually be a static site generator with interactive code for three uses cases:
- Postman Collection
- Markdown Documents
- OpenAPI
Publishing Postman collection is the first priority as there isn't a great alternative.
Static Site
Uses Svelte, TailwindCSS and Vite to generate the website and allow for hot reloading, folders and requests have classes applied to them, and the styling is controlled for the classes via Tailwind directives in the app.css file.
Configuration
config.yaml
at the root of this repo can be changed to allow retrieval of remote Postman collections via the Postman API e.g.
Get your collection ID by clicking the three dots next to its name and clicking settings
collection_from_api: true
postman_api_key: "XXXXX-XXXXX-XXXXX-XXXX"
collection_id: "XXXXXXX-XXXXXXXXX-XXXXXXXXX-XXXXXX"
You can override the base config.yaml
by putting a new file in your config folder e.g.:
- 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
Dependencies
~8–24MB
~350K SLoC