Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
nksaraf committed Feb 15, 2024
1 parent f278e06 commit 36f4e51
Show file tree
Hide file tree
Showing 11 changed files with 213 additions and 2,509 deletions.
240 changes: 116 additions & 124 deletions docs/api/server/request.md

Large diffs are not rendered by default.

715 changes: 29 additions & 686 deletions docs/api/server/response.md

Large diffs are not rendered by default.

1,695 changes: 0 additions & 1,695 deletions docs/api/server/runtime.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/guide/a-story.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Wait the color on the website didn't change. Well that's annoying. Okay, let's r

I don't know about you, but I want some confetti when I click the button. Let's add a library to do that.

I looked around and found this library called [canvas-confetti]().
I looked around and found this library called [canvas-confetti](https://www.npmjs.com/package/canvas-confetti).

Let's install it.

Expand Down
File renamed without changes.
58 changes: 58 additions & 0 deletions docs/guide/create-your-first-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
### React SSR

```ts
import reactRefresh from "@vitejs/plugin-react";
import { createApp } from "vinxi";

export default createApp({
routers: [
{
name: "public",
type: "static",
dir: "./public",
},
{
name: "client",
type: "client",
handler: "./app/client.tsx",
plugins: () => [reactRefresh()],
base: "/_build",
},
{
name: "ssr",
type: "http",
handler: "./app/server.tsx",
},
],
});
```

### Solid SSR

```ts
import { createApp } from "vinxi";
import solid from "vite-plugin-solid";

export default createApp({
routers: [
{
name: "public",
type: "static",
dir: "./public",
},
{
name: "client",
type: "client",
handler: "./app/client.tsx",
plugins: () => [solid({ ssr: true })],
base: "/_build",
},
{
name: "ssr",
type: "http",
handler: "./app/server.tsx",
plugins: () => [solid({ ssr: true })],
},
],
});
```
2 changes: 1 addition & 1 deletion docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ bun install vinxi

:::

`Vinxi` is a full stack JavaScript SDK to build apps and frameworks of all kinds with your own opinions. Our only opinion is that we like JavaScript/TypeScript and we want to see it eat the world. It is powered by some of the most foundational tools in the JavaScript ecosystem: [Vite](), [Nitro]() and [Rollup]() (and many other tools contributed by the community).
`Vinxi` is a full stack JavaScript SDK to build apps and frameworks of all kinds with your own opinions. Our only opinion is that we like JavaScript/TypeScript and we want to see it eat the world. It is powered by some of the most foundational tools in the JavaScript ecosystem: [Vite](https://vitejs.dev), [Nitro](https://nitro.unjs.io) and [Rollup](https://rollupjs.org) (and many other tools contributed by the community).

Being a SDK, `vinxi` is a collection of primitives that you can bend to your will to compose your own full stack applications and frameworks. You might be coming here from a specific context and use case. So depending on your use case, you can choose where to start your journey:

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/what-is-a-router.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export default createApp({

This works both in client and server targets. The restriction is that the client can only access it's own manifest, whereas the server can access all manifests.

To learn more about the manifest, check out the [Manifest API](/docs/manifest).
To learn more about the manifest, check out the [Manifest API](/api/manifest).

::: code-group

Expand Down
Empty file added docs/guide/why-vinxi.md
Empty file.
3 changes: 3 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,8 @@
"vinxi": "workspace:^",
"vitepress": "1.0.0-rc.42",
"vue": "^3.4.19"
},
"devDependencies": {
"zod": "^3.22.2"
}
}
5 changes: 4 additions & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 36f4e51

Please sign in to comment.