Skip to content

Commit a852cbc

Browse files
authored
Merge pull request #150 from coopbri/docs/overview-typos
Enhance overview page documentation
2 parents 1935f8c + 793edb0 commit a852cbc

File tree

1 file changed

+42
-44
lines changed

1 file changed

+42
-44
lines changed

docs/plugins/overview.md

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ head:
77

88
- - meta
99
- name: 'description'
10-
content: Elysia is designed to be modular and lightweight. That's why Elysia is creating pre-built common pattern plugin for convenient usage for developers, and thanks to community plugins for customizing Elysia even further.
10+
content: Elysia is designed to be modular and lightweight, which is why Elysia includes pre-built plugins involving common patterns for convenient developer usage. Elysia is enhanced by community plugins which customize it even further.
1111

1212
- - meta
1313
- name: 'og:description'
14-
content: Elysia is designed to be modular and lightweight. That's why Elysia is creating pre-built common pattern plugin for convenient usage for developers, and thanks to community plugins for customizing Elysia even further.
14+
content: Elysia is designed to be modular and lightweight, which is why Elysia includes pre-built plugins involving common patterns for convenient developer usage. Elysia is enhanced by community plugins which customize it even further.
1515
---
1616

1717
# Overview
@@ -21,52 +21,50 @@ Following the same idea as Arch Linux (btw, I use Arch):
2121

2222
> Design decisions are made on a case-by-case basis through developer consensus
2323
24-
To ensure that developers endup with performant web server they intent to created.
25-
26-
That's why Elysia is creating pre-built common pattern plugin for convinient usage for developers:
24+
This is to ensure developers end up with a performant web server they intend to create. By extension, Elysia includes pre-built common pattern plugins for convenient developer usage:
2725

2826
## Official plugins:
29-
- [Bearer](/plugins/bearer) - retreiving Bearer token automatically
30-
- [CORS](/plugins/cors) - setup Cross Origin Request request
31-
- [Cron](/plugins/cron) - setup cronjob
32-
- [Eden](/plugins/eden/overview) - end-to-end type safe client for Elysia
33-
- [GraphQL Apollo](/plugins/graphql-apollo) - run GraphQL Apollo on Elysia
34-
- [GraphQL Yoga](/plugins/graphql-yoga) - run GraphQL Yoga on Elysia
35-
- [HTML](/plugins/html) - convenient plugin for handling HTML response
36-
- [JWT](/plugins/jwt) - authentication with JWT
37-
- [Server Timing](/plugins/server-timing) - audit performance bottleneck with Server Timing API
38-
- [Static](/plugins/static) - serve static file/folders
39-
- [Stream](/plugins/stream) - response streaming, and server sent event
40-
- [Swagger](/plugins/swagger) - generate Swagger documentation in 1 line
41-
- [tRPC](/plugins/trpc) - tRPC support
42-
- [WebSocket](/patterns/websocket) - websocket support
27+
- [Bearer](/plugins/bearer) - retrieve [Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/) token automatically
28+
- [CORS](/plugins/cors) - set up [Cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
29+
- [Cron](/plugins/cron) - set up [cron](https://en.wikipedia.org/wiki/Cron) job
30+
- [Eden](/plugins/eden/overview) - end-to-end type safety client for Elysia
31+
- [GraphQL Apollo](/plugins/graphql-apollo) - run [Apollo GraphQL](https://www.apollographql.com/) on Elysia
32+
- [GraphQL Yoga](/plugins/graphql-yoga) - run [GraphQL Yoga](https://github.com/dotansimha/graphql-yoga) on Elysia
33+
- [HTML](/plugins/html) - handle HTML responses
34+
- [JWT](/plugins/jwt) - authenticate with [JWTs](https://jwt.io/)
35+
- [Server Timing](/plugins/server-timing) - audit performance bottlenecks with the [Server-Timing API](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing)
36+
- [Static](/plugins/static) - serve static files/folders
37+
- [Stream](/plugins/stream) - integrate response streaming and [server-sent events (SSEs)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
38+
- [Swagger](/plugins/swagger) - generate [Swagger](https://swagger.io/) documentation
39+
- [tRPC](/plugins/trpc) - support [tRPC](https://trpc.io/)
40+
- [WebSocket](/patterns/websocket) - support [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)
4341

4442
## Community plugins:
45-
- [Lucia Auth](https://github.com/pilcrowOnPaper/lucia) - Authentication, simple and clean
46-
- [Elysia Clerk](https://github.com/wobsoriano/elysia-clerk) - Unofficial Clerk plugin for ElysiaJS
47-
- [Elysia Polyfills](https://github.com/bogeychan/elysia-polyfills) - run Elysia ecosystem on Node and Deno
48-
- [Vite](https://github.com/timnghg/elysia-vite) - Simple Elysia plugin that helps you use Vite. It serve your entry html file with Vite's scripts injected
49-
- [Elysia Helmet](https://github.com/DevTobias/elysia-helmet) - secure Elysia apps with various HTTP headers.
50-
- [Vite Plugin SSR](https://github.com/timnghg/elysia-vite-plugin-ssr) - Vite Plugin SSR using Elysia server
43+
- [Lucia Auth](https://github.com/pilcrowOnPaper/lucia) - authentication, simple and clean
44+
- [Elysia Clerk](https://github.com/wobsoriano/elysia-clerk) - unofficial Clerk authentication plugin
45+
- [Elysia Polyfills](https://github.com/bogeychan/elysia-polyfills) - run Elysia ecosystem on Node.js and Deno
46+
- [Vite](https://github.com/timnghg/elysia-vite) - serve entry HTML file with Vite's scripts injected
47+
- [Elysia Helmet](https://github.com/DevTobias/elysia-helmet) - secure Elysia apps with various HTTP headers
48+
- [Vite Plugin SSR](https://github.com/timnghg/elysia-vite-plugin-ssr) - Vite SSR plugin using Elysia server
5149
- [OAuth2](https://github.com/bogeychan/elysia-oauth2) - handle OAuth 2.0 authorization code flow
52-
- [Rate Limit](https://github.com/rayriffy/elysia-rate-limit) - simple lightweight rate limiter
53-
- [Logysia](https://github.com/tristanisham/logysia) - classic logging elysia middleware
54-
- [Logger](https://github.com/bogeychan/elysia-logger) - pino logging elysia middleware
55-
- [Elysia Lambda](https://github.com/TotalTechGeek/elysia-lambda) - deploy Elysia on AWS Lambda
56-
- [Decorators](https://github.com/gaurishhs/elysia-decorators) - use typescript decorators with elysia
57-
- [Autoroutes](https://github.com/wobsoriano/elysia-autoroutes) - file system routes for Elysia
58-
- [Group Router](https://github.com/itsyoboieltr/elysia-group-router) - file system and folder-based router for groups.
59-
- [Basic Auth](https://github.com/itsyoboieltr/elysia-basic-auth) - basic http authentication for Elysia.
60-
- [ETag](https://github.com/bogeychan/elysia-etag) - automatic HTTP ETags generation for Elysia.
61-
- [Basic Auth](https://github.com/eelkevdbos/elysia-basic-auth) - Basic http authentication for Elysia (using 'request' event).
62-
- [i18n](https://github.com/eelkevdbos/elysia-i18next) - i18n wrapper for Elysia based on i18next
63-
- [Elysia Request ID](https://github.com/gtramontina/elysia-requestid) - Adds/Forwards request IDs (`X-Request-ID` or custom).
64-
- [Elysia HTMX](https://github.com/gtramontina/elysia-htmx) - Context helpers for [HTMX](https://htmx.org/).
65-
- [Elysia HMR HTML](https://github.com/gtrabanco/elysia-hmr-html) - Reload html files when change any file in a directory
66-
- [Elysia Inject HTML](https://github.com/gtrabanco/elysia-inject-html) - So simple plugin to inject HTML code in HTML files
67-
- [Elysia HTTP Error](https://github.com/yfrans/elysia-http-error) - Easiest way to return HTTP errors from Elysia handlers
68-
- [Elysia Http Status Code](https://github.com/sylvain12/elysia-http-status-code) - Simple http status code plugin for Elysia.js
69-
- [NoCache](https://github.com/gaurishhs/elysia-nocache) - A plugin for Elysia to disable caching
50+
- [Rate Limit](https://github.com/rayriffy/elysia-rate-limit) - simple, lightweight rate limiter
51+
- [Logysia](https://github.com/tristanisham/logysia) - classic logging middleware
52+
- [Logger](https://github.com/bogeychan/elysia-logger) - [pino](https://github.com/pinojs/pino)-based logging middleware
53+
- [Elysia Lambda](https://github.com/TotalTechGeek/elysia-lambda) - deploy on AWS Lambda
54+
- [Decorators](https://github.com/gaurishhs/elysia-decorators) - use TypeScript decorators
55+
- [Autoroutes](https://github.com/wobsoriano/elysia-autoroutes) - filesystem routes
56+
- [Group Router](https://github.com/itsyoboieltr/elysia-group-router) - filesystem and folder-based router for groups
57+
- [Basic Auth](https://github.com/itsyoboieltr/elysia-basic-auth) - basic HTTP authentication
58+
- [ETag](https://github.com/bogeychan/elysia-etag) - automatic HTTP [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) generation
59+
- [Basic Auth](https://github.com/eelkevdbos/elysia-basic-auth) - basic HTTP authentication (using `request` event)
60+
- [i18n](https://github.com/eelkevdbos/elysia-i18next) - [i18n](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/i18n) wrapper based on [i18next](https://www.i18next.com/)
61+
- [Elysia Request ID](https://github.com/gtramontina/elysia-requestid) - add/forward request IDs (`X-Request-ID` or custom)
62+
- [Elysia HTMX](https://github.com/gtramontina/elysia-htmx) - context helpers for [HTMX](https://htmx.org/)
63+
- [Elysia HMR HTML](https://github.com/gtrabanco/elysia-hmr-html) - reload HTML files when changing any file in a directory
64+
- [Elysia Inject HTML](https://github.com/gtrabanco/elysia-inject-html) - inject HTML code in HTML files
65+
- [Elysia HTTP Error](https://github.com/yfrans/elysia-http-error) - return HTTP errors from Elysia handlers
66+
- [Elysia Http Status Code](https://github.com/sylvain12/elysia-http-status-code) - integrate HTTP status codes
67+
- [NoCache](https://github.com/gaurishhs/elysia-nocache) - disable caching
7068

7169
---
72-
If you have plugin written for Elysia, feels free to share you plugin by creating PR to [documentation repo](https://github.com/elysiajs/documentation).
70+
If you wrote a plugin for Elysia, feel free to share it by creating a PR on the [documentation repo](https://github.com/elysiajs/documentation).

0 commit comments

Comments
 (0)