Skip to content

Commit

Permalink
docs: copy updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rossrobino committed Sep 7, 2024
1 parent f7ffed1 commit 4bef2a0
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# domco

## Construct Web Applications with Vite and Hono
## A Minimal Full-Stack JavaScript Framework

```bash
npm create domco@latest
Expand Down
17 changes: 1 addition & 16 deletions apps/docs/src/components/Hero.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,7 @@ import type { FC } from "hono/jsx";
export const Hero: FC = () => {
return (
<section class="flex flex-col">
<h1>
Construct Web Applications with{" "}
<a
href="https://vitejs.dev"
class="bg-gradient-to-r from-sky-400 to-violet-400 bg-clip-text text-transparent"
>
Vite
</a>{" "}
and{" "}
<a
href="https://hono.dev/"
class="bg-gradient-to-r from-red-600 to-orange-600 bg-clip-text text-transparent"
>
Hono
</a>
</h1>
<h1>A Minimal Full-Stack JavaScript Framework</h1>
<Npm />
</section>
);
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/components/Layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export const Layout: FC<LayoutProps> = ({ title, children, client }) => {
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta
name="description"
content="Construct Web Applications with Vite and Hono."
content="A Minimal Full-Stack JavaScript Framework."
/>
<title>{title}</title>
</head>
Expand Down
17 changes: 13 additions & 4 deletions apps/docs/src/content/_preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,17 @@ export default app;
<br>
<br>

domco is a library that turns your [Vite](https://vitejs.dev) project into a [Hono](https://hono.dev) application. You can take
advantage of Vite's build pipeline, plugins, and HMR in a full-stack
context using Hono as your web server.
<h2 class="text-balance">
Construct Web Applications with
<span class="bg-gradient-to-r from-sky-400 to-violet-400 bg-clip-text text-transparent">
Vite
</span>
and
<span class="bg-gradient-to-r from-red-600 to-orange-600 bg-clip-text text-transparent">
Hono
</span>
</h2>

This project is inspired by other projects including [HonoX](https://github.com/honojs/honox), [Vinxi](https://vinxi.vercel.app/), and [SvelteKit](https://kit.svelte.dev). It aims to be a minimal layer that connects Vite and Hono, without adding much to your bundle size.
domco turns your [Vite](https://vitejs.dev) project into a [Hono](https://hono.dev) application. You can take advantage of Vite's build pipeline, plugins, and HMR in a full-stack context using Hono as your web server.

This project is inspired by other projects including [HonoX](https://github.com/honojs/honox), [Vinxi](https://vinxi.vercel.app/), and [SvelteKit](https://kit.svelte.dev). domco aims to be a minimal layer that connects Vite and Hono, it has no other dependencies.
8 changes: 5 additions & 3 deletions apps/docs/src/content/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ Run `vite build` to build your application into `dist/`.
└── (adapter-entry.js)
```

By default **domco** will generate a `app.js` module and static assets for your application. If you are not using an [adapter](#adapters), you can import `createApp` from the `app.js` module and configure your app to use in one of [Hono's supported environments](https://hono.dev/docs/getting-started/basic).

The `client/` directory holds client assets. JS and CSS assets with hashed file names will be output to `dist/client/_immutable/`, you can serve this path with immutable cache headers. Other assets are processed and included in `dist/client/` directly.
By default domco will generate a `app.js` module and static assets for your application.

## Example

If you are not using an [adapter](#adapters), you can import `createApp` from the `app.js` module and configure your app to use in one of [Hono's supported environments](https://hono.dev/docs/getting-started/basic).

The `client/` directory holds client assets. JS and CSS assets with hashed file names will be output to `dist/client/_immutable/`, you can serve this path with immutable cache headers. Other assets are processed and included in `dist/client/` directly.

Here's an example of how to serve your app using the result of your build with [`@hono/node-server`](https://github.com/honojs/node-server).

```ts
Expand Down
2 changes: 1 addition & 1 deletion packages/domco/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "domco",
"description": "Construct Web Applications with Vite and Hono",
"description": "A Minimal Full-Stack JavaScript Framework",
"version": "0.10.0",
"author": {
"name": "Ross Robino",
Expand Down

0 comments on commit 4bef2a0

Please sign in to comment.