Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Feb 23, 2024
1 parent 1d8b389 commit 5e3b5e5
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/1.guide/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@ icon: ph:book-open-duotone
## Overview

h3 (short for HTTP) is a lightweight and [composable](/utils) server framework for JavaScript that is designed to
h3 (short for HTTP, pronounced as /eɪtʃθriː/, like h-3) is a lightweight and [composable](/utils) server framework for JavaScript that is designed to
work with various javascript runtimes through [adapters](/adapters).

::read-more{to="https://nitro.unjs.io"}
Check out [Nitro](https://nitro.unjs.io) for a full featured server toolkit.
::

## Quick Start

Create a new file `app.ts` (or `app.js`):
Expand Down
4 changes: 4 additions & 0 deletions docs/1.guide/2.app.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: ic:baseline-bolt
---

# App Instance

> App instance is the core of a h3 server.
Expand Down
4 changes: 4 additions & 0 deletions docs/1.guide/2.event-handler.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: fluent:target-24-regular
---

# Event Handler

> Event handler define application logic.
Expand Down
4 changes: 4 additions & 0 deletions docs/1.guide/4.event.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: material-symbols-light:data-object
---

# Event Object

> Event object carries an incoming request and context.
Expand Down
4 changes: 4 additions & 0 deletions docs/1.guide/5.router.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: solar:route-linear
---

# Router

> Split your application using routes.
Expand Down
4 changes: 4 additions & 0 deletions docs/1.guide/99.nightly.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: ph:moon
---

# Nightly Builds

You can opt-in to early test latest h3 changes using automated nightly release channel.
Expand Down
4 changes: 4 additions & 0 deletions docs/3.adapters/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ icon: codicon:run-all
The [app instance](/guide/app) of h3 is lightweight without any logic about runtime it is going to run.
Using h3 adapters, we can easily integrate server with each runtime.

::read-more{to="https://nitro.unjs.io"}
Check out [Nitro](https://nitro.unjs.io) for a full featured server toolkit and more deployment options.
::

There are 3 base adapters:

- [Node.js](/adapters/node)
Expand Down

0 comments on commit 5e3b5e5

Please sign in to comment.