https://github.com/hyper63/docs
The new hyper docs site
https://github.com/hyper63/docs
clean-architecture deno docs hyper nodejs ports-and-adapters service-framework vitepress
Last synced: about 2 months ago
JSON representation
The new hyper docs site
- Host: GitHub
- URL: https://github.com/hyper63/docs
- Owner: hyper63
- Created: 2024-01-01T21:54:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T20:19:27.000Z (over 1 year ago)
- Last Synced: 2025-01-13T05:41:43.146Z (9 months ago)
- Topics: clean-architecture, deno, docs, hyper, nodejs, ports-and-adapters, service-framework, vitepress
- Language: CSS
- Homepage: https://docs.hyper.io/
- Size: 490 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# hyper Docs
The new docs for the hyper Service Framework
## Getting Started
> If you're using GitPod, then this is already done for you
Simply run `yarn` to install dependencies, then `yarn dev` to start the dev server.
## Project Structure
The project is a standard [`Vitepress`](https://vitepress.dev/) site.
The docs are layed out in 4 different sections, within `/docs`.
| Section | Description |
| ------------- | -------------------------------------------------------------- |
| Api Reference | References to the various `App` interfaces for hyper |
| Concepts | Building blocks of hyper that are good to know for development |
| Build | References and guides on how to build with hyper |
| Host | Guides on how to host hyper |
## Request Missing Content
Missing something on the docs? This something isn't right? Think there should be another section?
Please create an issue and we'll try to get it added!
## Contributing
See [Contributing](./CONTRIBUTING.md)