https://github.com/vahor/docs-template
https://github.com/vahor/docs-template
documentation markdown openapi react
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/vahor/docs-template
- Owner: Vahor
- Created: 2024-12-31T11:05:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-22T18:40:23.000Z (about 1 year ago)
- Last Synced: 2025-01-22T19:39:01.731Z (about 1 year ago)
- Topics: documentation, markdown, openapi, react
- Language: TypeScript
- Homepage: https://vahor.github.io/docs-template/
- Size: 591 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Build
```bash
bun run build
```
# Serve
Everything is in `out` folder. You can debug locally with the default Caddy file:
```bash
caddy run
```
and open https://localhost:8080
## Default pages
- Changelog: `https://localhost:8080/changelog/something`
## Inspiration
- Github api docs: https://docs.github.com/en/rest/activity/feeds?apiVersion=2022-11-28
- Stripe docs: https://docs.stripe.com/payments
- stripe api docs: https://stripe.com/docs/api
- mintlify docs + components : https://mintlify.com/ + https://github.com/mintlify/components
- auth0: https://auth0.com/docs/api/management/v2/actions/get-actions
- openai: https://platform.openai.com/docs/api-reference/chat/create
- https://supabase.com/docs/reference/api/v1-list-all-snippets
- https://github.com/fuma-nama/fumadocs/tree/dev/packages/ui/src/theme/typography
- https://docs.scalar.com/swagger-editor#version-0/reference/tag/planets/GET/planets/{planetId} for the modal editor