From 5299cf1b408b546609a85428384a5c1b26b230b7 Mon Sep 17 00:00:00 2001 From: Romain Lenzotti Date: Sat, 30 Nov 2024 22:38:45 +0100 Subject: [PATCH] docs: update home content --- docs/.vitepress/config.mts | 2 +- docs/.vitepress/theme/index.ts | 10 +- docs/.vitepress/theme/style.css | 4 + docs/api.md | 12 +- docs/docs/authentication.md | 12 +- docs/docs/cache.md | 12 +- docs/docs/command.md | 12 +- docs/docs/configuration/index.md | 12 +- docs/docs/controllers.md | 12 +- docs/docs/exceptions.md | 12 +- docs/docs/json-mapper.md | 12 +- docs/docs/logger.md | 12 +- docs/docs/model.md | 12 +- docs/docs/platform-serverless-http.md | 12 +- docs/docs/platform-serverless.md | 12 +- docs/docs/providers-lazy-loading.md | 12 +- docs/docs/providers.md | 12 +- docs/docs/response-filter.md | 12 +- docs/docs/serve-files.md | 12 +- docs/docs/templating.md | 12 +- docs/docs/upload-files.md | 12 +- docs/getting-started.md | 147 ++++++++++++++++++ docs/index.md | 25 +-- .../create-your-first-controller.md | 12 +- docs/introduction/getting-started.md | 8 +- docs/introduction/migrate-from-v7.md | 12 +- docs/plugins/index.md | 12 +- readme.md | 11 +- 28 files changed, 331 insertions(+), 128 deletions(-) create mode 100644 docs/getting-started.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 867340ca81a..90c75223bcd 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -8,7 +8,7 @@ import {getSidebar} from "./api.js"; export default defineConfig({ title: "Ts.ED", lastUpdated: true, - + description: "Ts.ED is a modern Node.js framework built with TypeScript. It offers a flexible structure with a fast learning curve, specifically designed to improve the developer experience. Ts.ED provides numerous decorators and guidelines to make your code more readable and less error-prone. It supports various platforms and tools, including Node.js/Bun.js, Express.js/Koa.js, CLI, and serverless architectures (e.g., AWS).", sitemap: { hostname: "https://tsed.io" }, diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index c7f17922b83..863ac1a1d85 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,15 +1,15 @@ // https://vitepress.dev/guide/custom-theme import {DefaultTheme} from "@tsed/vitepress-theme"; -import type {Theme} from "vitepress"; -import {h} from "vue"; import HomeBanner from "@tsed/vitepress-theme/organisms/home/HomeBanner.vue"; -import HomePartners from "@tsed/vitepress-theme/organisms/home/HomePartners.vue"; import HomeBody from "@tsed/vitepress-theme/organisms/home/HomeBody.vue"; +import HomePartners from "@tsed/vitepress-theme/organisms/home/HomePartners.vue"; import HomeTabsTerminal from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabsTerminal.vue"; +import HomeTabTerminalBun from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalBun.vue"; import HomeTabTerminalNpm from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalNpm.vue"; -import HomeTabTerminalYarn from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalYarn.vue"; import HomeTabTerminalPnpm from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalPnpm.vue"; -import HomeTabTerminalBun from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalBun.vue"; +import HomeTabTerminalYarn from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalYarn.vue"; +import type {Theme} from "vitepress"; +import {h} from "vue"; import "./style.css"; export default { diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css index f00ef8b1960..fd8b9049a5f 100644 --- a/docs/.vitepress/theme/style.css +++ b/docs/.vitepress/theme/style.css @@ -3,3 +3,7 @@ padding-right: 0; } + +.box a { + color: var(--vp-c-brand-1); +} diff --git a/docs/api.md b/docs/api.md index 6acd11e620b..aad5a15c0c9 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,11 +1,13 @@ --- layout: page sidebar: false -meta: - - name: description - content: Api Reference of Ts.ED. Use decorator to build your model and map data. - - name: keywords - content: api reference model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization +head: + - - meta + - name: description + content: Api Reference of Ts.ED. Use decorator to build your model and map data. + - - meta + - name: keywords + content: api reference model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization ---