Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: refactor ssr #166

Merged
merged 5 commits into from May 19, 2021
Merged

docs: refactor ssr #166

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
07370ad
docs: refactor ssr
brillout May 19, 2021
f41df5f
docs: create separate sections for Frameworks and Boilerplates
brillout May 19, 2021
1e06f27
docs: add links to SSR frameworks section + remove SSR Boilerplates s…
brillout May 19, 2021
f86c9b6
docs: improve SSR frameworks note.
brillout May 19, 2021
df6bace
docs: update SSR framework hash link
brillout May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 27 additions & 7 deletions README.md
View file
Open in desktop
Expand Up @@ -121,10 +121,6 @@ Use the "Table on Contents" menu on the top-left corner to explore the list.
- [vite-plugin-html-config](https://github.com/ahwgs/vite-plugin-html-config) - HTML tag configuration, such as script link style meta favicon and more.
- [vite-plugin-html-template](https://github.com/IndexXuan/vite-plugin-html-template) - HTML template for vite app, like html-webpack-plugin for webpack.

#### SSR

- [vite-plugin-ssr](https://github.com/brillout/vite-plugin-ssr) - Like Nuxt/Next.js but with a simpler design that works with any view framework.

#### Helpers

- [vite-tsconfig-paths](https://github.com/aleclarson/vite-tsconfig-paths) - Support for TypeScript's path mapping.
Expand Down Expand Up @@ -176,11 +172,13 @@ In this section, we use badges to indicate the targeted Vue version for each plu
- ![v3] [vite-plugin-vuedoc](https://github.com/JasKang/vite-plugin-vuedoc) - Markdown Code block as Vue Preview components.
- ![v3] [vite-svg-loader](https://github.com/jpkleemans/vite-svg-loader) - Load SVG files as Vue components.

#### SSR / SSG
#### SSR

SSR frameworks are listed at [SSR - Frameworks](#ssr).

#### SSG

- ![v3] [vite-ssg](https://github.com/antfu/vite-ssg) - Server-side generation.
- ![v3] [vite-ssr](https://github.com/frandiox/vite-ssr) - Server-side rendering.
- ![v3] [vitedge](https://github.com/frandiox/vitedge) - Edge-side rendering with fullstack utilities.

Copy link
Member

@antfu antfu May 19, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we extract SSR into another section, maybe it's better to add a line saying that "Refer to the SSR section for SSR supports"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean?

Copy link
Member

@antfu antfu May 19, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like, I might look into the Vue section and trying to find the SSR support for Vue. But now we move it to another section, which might confuse ppl like "Oh Vite does not support SSR for Vue?" or some sort of the things.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

I've decided to remove the SSR Boilerplates section because the whole idea here is to let users know about higher-level alternatives to Vite's native SSR API; boilerplates are not contributing here.

#### Ecosystem

Expand Down Expand Up @@ -220,6 +218,8 @@ In this section, we use badges to indicate the targeted Vue version for each plu

#### Framework

> 💡 SSR frameworks are listed at [SSR - Frameworks](#ssr).

- [vite-plugin-react-pages](https://github.com/vitejs/vite-plugin-react-pages) - A Vite framework for building React app.
- [@vitjs/vit](https://github.com/vitjs/vit) - React application framework inspired by UmiJS.

Expand Down Expand Up @@ -274,6 +274,26 @@ In this section, we use badges to indicate the targeted Vue version for each plu

- Check the [Awesome Rollup list](https://github.com/rollup/awesome) for community maintained rollup plugins, and refer to the Vite docs section about [rollup plugin compatibility](https://vitejs.dev/guide/api-plugin.html#rollup-plugin-compatiblity).

## SSR

[react]: https://img.shields.io/badge/-React-61dafb
[vue2]: https://img.shields.io/badge/-Vue%20v2-41b883
[vue3]: https://img.shields.io/badge/-Vue%20v3-41b883
[svelte]: https://img.shields.io/badge/-Svelte-ff3e00

<!--lint disable awesome-list-item-->

### Libraries

- [vite-ssr](https://github.com/frandiox/vite-ssr) ![react] ![vue3] - Server-side rendering.
- [vite-plugin-ssr](https://github.com/brillout/vite-plugin-ssr) ![react] ![vue3] ![vue2] ![svelte] - Like Nuxt/Next.js but as a do-one-thing-do-it-well plugin.

### Frameworks

- [vitedge](https://github.com/frandiox/vitedge) ![react] ![vue3] - Edge-side rendering with fullstack utilities.

<!--lint enable awesome-list-item-->

## Integrations with Backends

### Ruby on Rails
Expand Down