Skip to content

Commit

Permalink
docs: update vike documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Jan 25, 2024
1 parent cdff939 commit 2431ccc
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 4 deletions.
67 changes: 67 additions & 0 deletions docs/.vuepress/public/vike.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,9 @@ frameworks:
- title: BullMQ
href: /tutorials/bullmq.html
src: /bullmq.png
- title: Vike
href: /tutorials/vike.html
src: /vike.svg
---

::: slot hero-brand
Expand Down
16 changes: 12 additions & 4 deletions docs/tutorials/vike.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,32 @@ meta:
content: ts.ed express typescript vite ssr plugin node.js javascript decorators
projects:
- title: Vike react example
href: https://github.com/tsedio/tsed-vike-example
src: /vike.svg
- title: Vite react example
href: https://github.com/tsedio/tsed-vite-plugin-ssr-example
src: https://vite-plugin-ssr.com/assets/static/vite-plugin-ssr.5177312a.svg
---

# Vike

<Banner src="https://vite-plugin-ssr.com/assets/static/vite-plugin-ssr.5177312a.svg" href="https://vite-plugin-ssr.com/" height="200" />
<Banner src="/vike.svg" href="https://vite-plugin-ssr.com/" height="200" />

> Like Next.js/Nuxt but as do-one-thing-do-it-well Vike.
> Like Next.js/Nuxt but as do-one-thing-do-it-well Vite plugin.
Use **any UI framework** (React, Vue, Svelte, Solid, ...) and **any tool** you want (any frontend library, web
technology, deploy environment, Vite plugin, ...).

With `vike`, you integrate tools manually and keep `architectural control`.

::: tip Note
Vike replace the `vite-plugin-ssr` package. Ts.ED provides `@tsed/vite-ssr-plugin` and `@tsed/vike` packages.
All new features will only embed to `@tsed/vike` package.
:::

::: tip
You can read also this article over Ts.ED + Vite-plugin-ssr on Medium:
https://romainlenzotti.medium.com/use-vite-and-ts-ed-to-build-your-website-84fb4c0d8079
[https://romainlenzotti.medium.com/use-vite-and-ts-ed-to-build-your-website-84fb4c0d8079](https://romainlenzotti.medium.com/use-vite-and-ts-ed-to-build-your-website-84fb4c0d8079)
:::

## Features
Expand Down Expand Up @@ -110,7 +118,7 @@ export class IndexController {

And his React component:

```ts
```tsx
import React from "react";
import {PageContext} from "../../renderer/types";
import type {SwaggerSettings} from "@tsed/swagger"; // ! keep type import
Expand Down

0 comments on commit 2431ccc

Please sign in to comment.