From 4bef2a0888e6e434cf6c4f019ad2391197c83118 Mon Sep 17 00:00:00 2001 From: rossrobino Date: Sat, 7 Sep 2024 16:00:30 -0400 Subject: [PATCH] docs: copy updates --- README.md | 2 +- apps/docs/src/components/Hero.tsx | 17 +---------------- apps/docs/src/components/Layout.tsx | 2 +- apps/docs/src/content/_preview.md | 17 +++++++++++++---- apps/docs/src/content/deploy.md | 8 +++++--- packages/domco/package.json | 2 +- 6 files changed, 22 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index db25eee..b1133d9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # domco -## Construct Web Applications with Vite and Hono +## A Minimal Full-Stack JavaScript Framework ```bash npm create domco@latest diff --git a/apps/docs/src/components/Hero.tsx b/apps/docs/src/components/Hero.tsx index e3d5746..e4e6949 100644 --- a/apps/docs/src/components/Hero.tsx +++ b/apps/docs/src/components/Hero.tsx @@ -3,22 +3,7 @@ import type { FC } from "hono/jsx"; export const Hero: FC = () => { return (
-

- Construct Web Applications with{" "} - - Vite - {" "} - and{" "} - - Hono - -

+

A Minimal Full-Stack JavaScript Framework

); diff --git a/apps/docs/src/components/Layout.tsx b/apps/docs/src/components/Layout.tsx index b480af7..76483f0 100644 --- a/apps/docs/src/components/Layout.tsx +++ b/apps/docs/src/components/Layout.tsx @@ -27,7 +27,7 @@ export const Layout: FC = ({ title, children, client }) => { {title} diff --git a/apps/docs/src/content/_preview.md b/apps/docs/src/content/_preview.md index 7c408ca..39e11fa 100644 --- a/apps/docs/src/content/_preview.md +++ b/apps/docs/src/content/_preview.md @@ -17,8 +17,17 @@ export default app;

-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. +

+ Construct Web Applications with + + Vite + + and + + Hono + +

-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. diff --git a/apps/docs/src/content/deploy.md b/apps/docs/src/content/deploy.md index 7a92036..0621f14 100644 --- a/apps/docs/src/content/deploy.md +++ b/apps/docs/src/content/deploy.md @@ -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 diff --git a/packages/domco/package.json b/packages/domco/package.json index 3450066..8d7765c 100644 --- a/packages/domco/package.json +++ b/packages/domco/package.json @@ -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",