From e94d1f5829a94f25b7d1422699af84f5fcb8a5c5 Mon Sep 17 00:00:00 2001 From: Josh Stout Date: Fri, 13 Dec 2024 04:39:48 +0800 Subject: [PATCH 1/2] Update key-concept.md fix typo --- docs/key-concept.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/key-concept.md b/docs/key-concept.md index 62750b65..924aae24 100644 --- a/docs/key-concept.md +++ b/docs/key-concept.md @@ -28,7 +28,7 @@ Every Elysia instance is a component. A component is a plugin that could plug in to other instances. -A comonent could be a router, a store, a service, or anything else. +A component could be a router, a store, a service, or anything else. ```ts twoslash import { Elysia } from 'elysia' From c5759560ca172e1e85a9191aad99453ab85397dd Mon Sep 17 00:00:00 2001 From: Josh Stout Date: Fri, 13 Dec 2024 05:48:11 +0900 Subject: [PATCH 2/2] add plural to everything for key concepts doc --- docs/.vitepress/config.ts | 4 ++-- docs/{key-concept.md => key-concepts.md} | 6 +++--- docs/quick-start.md | 2 +- docs/tutorial.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) rename docs/{key-concept.md => key-concepts.md} (98%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index b631df3f..cea562ee 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -132,8 +132,8 @@ export default defineConfig({ link: '/tutorial' }, { - text: 'Key Concept', - link: '/key-concept' + text: 'Key Concepts', + link: '/key-concepts' }, { text: 'Table of Content', diff --git a/docs/key-concept.md b/docs/key-concepts.md similarity index 98% rename from docs/key-concept.md rename to docs/key-concepts.md index 924aae24..b791a945 100644 --- a/docs/key-concept.md +++ b/docs/key-concepts.md @@ -1,9 +1,9 @@ --- -title: Key Concept - ElysiaJS +title: Key Concepts - ElysiaJS head: - - meta - property: 'og:title' - content: Key Concept - ElysiaJS + content: Key Concepts - ElysiaJS - - meta - name: 'description' @@ -14,7 +14,7 @@ head: content: Although Elysia is a simple library, it has some key concepts that you need to understand to use it effectively. This page will guide you through the key concepts of ElysiaJS. --- -# Key Concept +# Key Concepts ### We __highly recommended__ you to read this page before start using Elysia. diff --git a/docs/quick-start.md b/docs/quick-start.md index 9114715e..4c2dc829 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -92,7 +92,7 @@ import Deck from '../components/nearl/card-deck.vue' - + The core concept of Elysia and how to use it. diff --git a/docs/tutorial.md b/docs/tutorial.md index d7b8c1aa..46deddce 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -25,7 +25,7 @@ We expected it to take around 15-20 minutes if you follow along. --- ### Not a fan of tutorial? -If you prefers to a more try-it-yourself approach, you can skip this tutorial and go straight to the [key concept](/key-concept) page to get a good understanding of how Elysia works. +If you prefers to a more try-it-yourself approach, you can skip this tutorial and go straight to the [key concepts](/key-concepts) page to get a good understanding of how Elysia works. - + The core concept of Elysia and how to use it.