Skip to content

Commit 22659f4

Browse files
RomakitaRomakita
committed
docs: update home content
1 parent 613150c commit 22659f4

33 files changed

+358
-170
lines changed

‎docs/.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ api
33
.vitepress/cache
44
.vitepress/dist
55
public/api.json
6+
public/reference-sidebar.json
67

78
# Yarn
89
.pnp.*
@@ -13,4 +14,3 @@ public/api.json
1314
!.yarn/cache
1415
!.yarn/sdks
1516
!.yarn/versions
16-

‎docs/.vitepress/config.mts

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
import {apiAnchor} from "@tsed/vitepress-theme/markdown/api-anchor/api-anchor.js";
22
import {defineConfig} from "vitepress";
33
import pkg from "../../package.json";
4-
import {getSidebar} from "./api.js";
4+
import referenceSidebar from "../public/reference-sidebar.json"
5+
import team from "../team.json"
56

67

78
// https://vitepress.dev/reference/site-config
89
export default defineConfig({
910
title: "Ts.ED",
1011
lastUpdated: true,
11-
12+
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).",
1213
sitemap: {
1314
hostname: "https://tsed.io"
1415
},
@@ -33,6 +34,7 @@ export default defineConfig({
3334
logo: "/tsed.svg",
3435
siteTitle: false,
3536
apiUrl: "/api.json",
37+
team,
3638
apiRedirectUrl: "",
3739
repo: "tsedio/tsed",
3840
githubProxyUrl: "https://api.tsed.io/rest/github/tsedio/tsed",
@@ -560,8 +562,7 @@ export default defineConfig({
560562
].sort((a, b) => a.text.localeCompare(b.text))
561563
}
562564
],
563-
564-
"/api/": getSidebar()
565+
"/api/": referenceSidebar
565566
},
566567
socialLinks: [
567568
{icon: "github", link: "https://github.com/tsedio/tsed"},

‎docs/.vitepress/api.ts ‎docs/.vitepress/scripts/api-summary.js

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import {mapApiReferences} from "@tsed/vitepress-theme/composables/api/mappers/mapApiReferences.js";
2-
import api from "../public/api.json";
2+
import api from "../../public/api.json" with { type: "json" };
3+
import {writeFile} from "node:fs/promises";
34

45
const IS_CORES = /core|@tsed\/di|hooks|schema$|\/exceptions$|engines|json-mapper|open-spec/;
56
const IS_PLATFORM = /platform/;
@@ -31,7 +32,7 @@ export function getSidebar() {
3132
platformModules.push(item);
3233
} else if (IS_ORM.test(module)) {
3334
ormModules.push(item);
34-
}else {
35+
} else {
3536
thirdParties.push(item);
3637
}
3738
});
@@ -56,3 +57,5 @@ export function getSidebar() {
5657
];
5758
}
5859

60+
61+
await writeFile(import.meta.dirname + "/../../public/reference-sidebar.json", JSON.stringify(getSidebar(), null, 2));

‎docs/.vitepress/theme/index.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
// https://vitepress.dev/guide/custom-theme
22
import {DefaultTheme} from "@tsed/vitepress-theme";
3-
import type {Theme} from "vitepress";
4-
import {h} from "vue";
53
import HomeBanner from "@tsed/vitepress-theme/organisms/home/HomeBanner.vue";
6-
import HomePartners from "@tsed/vitepress-theme/organisms/home/HomePartners.vue";
74
import HomeBody from "@tsed/vitepress-theme/organisms/home/HomeBody.vue";
85
import HomeTabsTerminal from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabsTerminal.vue";
6+
import HomeTabTerminalBun from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalBun.vue";
97
import HomeTabTerminalNpm from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalNpm.vue";
10-
import HomeTabTerminalYarn from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalYarn.vue";
118
import HomeTabTerminalPnpm from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalPnpm.vue";
12-
import HomeTabTerminalBun from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalBun.vue";
9+
import HomeTabTerminalYarn from "@tsed/vitepress-theme/organisms/home/terminal/HomeTabTerminalYarn.vue";
10+
import HomeBeforeFeatures from "@tsed/vitepress-theme/organisms/home/HomeBeforeFeatures.vue";
11+
import type {Theme} from "vitepress";
12+
import {h} from "vue";
1313
import "./style.css";
1414

1515
export default {
@@ -26,7 +26,7 @@ export default {
2626
bun: () => h(HomeTabTerminalBun)
2727
})
2828
}),
29-
"home-features-before": () => h(HomePartners),
29+
"home-features-before": () => h(HomeBeforeFeatures),
3030
"home-features-after": () => h(HomeBody)
3131
});
3232
}

‎docs/.vitepress/theme/style.css

+4
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
padding-right: 0;
44
}
55

6+
7+
.box a {
8+
color: var(--vp-c-brand-1);
9+
}

‎docs/api.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
layout: page
33
sidebar: false
4-
meta:
5-
- name: description
6-
content: Api Reference of Ts.ED. Use decorator to build your model and map data.
7-
- name: keywords
8-
content: api reference model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization
4+
head:
5+
- - meta
6+
- name: description
7+
content: Api Reference of Ts.ED. Use decorator to build your model and map data.
8+
- - meta
9+
- name: keywords
10+
content: api reference model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization
911
---
1012

1113
<script setup>

‎docs/docs/authentication.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Authentication configuration
5-
- name: keywords
6-
content: ts.ed express typescript auth node.js javascript decorators
2+
head:
3+
- - meta
4+
- name: description
5+
content: Authentication configuration
6+
- - meta
7+
- name: keywords
8+
content: ts.ed express typescript auth node.js javascript decorators
79
---
810

911
# Authentication

‎docs/docs/cache.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Cache management provided by Ts.ED framework. Use decorator to cache Response or returned value by a service.
5-
- name: keywords
6-
content: cache ts.ed express koa typescript node.js javascript decorators cache-manager class controller service
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Cache management provided by Ts.ED framework. Use decorator to cache Response or returned value by a service.
6+
- - meta
7+
- name: keywords
8+
content: cache ts.ed express koa typescript node.js javascript decorators cache-manager class controller service
79
---
810

911
# Cache

‎docs/docs/command.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Command provided by Ts.ED framework. Use commands to build your CLI API.
5-
- name: keywords
6-
content: command ts.ed commander inquirer typescript node.js javascript decorators jsonschema class models
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Command provided by Ts.ED framework. Use commands to build your CLI API.
6+
- - meta
7+
- name: keywords
8+
content: command ts.ed commander inquirer typescript node.js javascript decorators jsonschema class models
79
---
810

911
# Command

‎docs/docs/configuration/index.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over the server configuration. Ts.ED is built on top of Express/Koa and use TypeScript language.
5-
- name: keywords
6-
content: configuration ts.ed express typescript node.js javascript decorators mvc class models
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over the server configuration. Ts.ED is built on top of Express/Koa and use TypeScript language.
6+
- - meta
7+
- name: keywords
8+
content: configuration ts.ed express typescript node.js javascript decorators mvc class models
79
---
810

911
# Configuration

‎docs/docs/controllers.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Controllers provided by Ts.ED framework. Use controllers to build your REST API.
5-
- name: keywords
6-
content: controllers ts.ed express typescript node.js javascript decorators jsonschema class models
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Controllers provided by Ts.ED framework. Use controllers to build your REST API.
6+
- - meta
7+
- name: keywords
8+
content: controllers ts.ed express typescript node.js javascript decorators jsonschema class models
79
---
810

911
# Controllers

‎docs/docs/exceptions.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Http Exceptions provided by Ts.ED framework. Use class to throw a standard Http error.
5-
- name: keywords
6-
content: http exceptions ts.ed express typescript node.js javascript decorators jsonschema class models
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Http Exceptions provided by Ts.ED framework. Use class to throw a standard Http error.
6+
- - meta
7+
- name: keywords
8+
content: http exceptions ts.ed express typescript node.js javascript decorators jsonschema class models
79
---
810

911
# Exceptions

‎docs/docs/json-mapper.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over JsonMapper and decorators provided by Ts.ED framework. Use decorator to build your model and map data.
5-
- name: keywords
6-
content: class model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over JsonMapper and decorators provided by Ts.ED framework. Use decorator to build your model and map data.
6+
- - meta
7+
- name: keywords
8+
content: class model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization
79
---
810

911
# JsonMapper

‎docs/docs/logger.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Logger by Ts.ED framework.
5-
- name: keywords
6-
content: logger decorators ts.ed express.js koa.js typescript node.js javascript
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Logger by Ts.ED framework.
6+
- - meta
7+
- name: keywords
8+
content: logger decorators ts.ed express.js koa.js typescript node.js javascript
79
---
810

911
# Logger

‎docs/docs/model.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Models and decorators provided by Ts.ED framework. Use decorator to build your model and JsonSchema.
5-
- name: keywords
6-
content: class model decorators ts.ed express typescript node.js javascript jsonschema
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Models and decorators provided by Ts.ED framework. Use decorator to build your model and JsonSchema.
6+
- - meta
7+
- name: keywords
8+
content: class model decorators ts.ed express typescript node.js javascript jsonschema
79
---
810

911
# Model

‎docs/docs/platform-serverless-http.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Guide to deploy your Ts.ED application on AWS.
5-
- name: keywords
6-
content: ts.ed express typescript aws node.js javascript decorators
2+
head:
3+
- - meta
4+
- name: description
5+
content: Guide to deploy your Ts.ED application on AWS.
6+
- - meta
7+
- name: keywords
8+
content: ts.ed express typescript aws node.js javascript decorators
79
---
810

911
# Serverless HTTP

‎docs/docs/platform-serverless.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Guide to deploy your Ts.ED application on AWS.
5-
- name: keywords
6-
content: ts.ed express typescript serverless aws function node.js javascript decorators
2+
head:
3+
- - meta
4+
- name: description
5+
content: Guide to deploy your Ts.ED application on AWS.
6+
- - meta
7+
- name: keywords
8+
content: ts.ed express typescript serverless aws function node.js javascript decorators
79
projects:
810
- title: Terraform project
911
href: https://github.com/tsedio/tsed-aws-lambda

‎docs/docs/providers-lazy-loading.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Providers / DI provided by Ts.ED framework. Use providers to build your backend services.
5-
- name: keywords
6-
content: providers di ioc ts.ed express typescript node.js javascript decorators jsonschema class models
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Providers / DI provided by Ts.ED framework. Use providers to build your backend services.
6+
- - meta
7+
- name: keywords
8+
content: providers di ioc ts.ed express typescript node.js javascript decorators jsonschema class models
79
---
810

911
# Lazy-loading provider

‎docs/docs/providers.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over Providers / DI provided by Ts.ED framework. Use providers to build your backend services.
5-
- name: keywords
6-
content: providers di ioc ts.ed express typescript node.js javascript decorators jsonschema class models
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over Providers / DI provided by Ts.ED framework. Use providers to build your backend services.
6+
- - meta
7+
- name: keywords
8+
content: providers di ioc ts.ed express typescript node.js javascript decorators jsonschema class models
79
---
810

911
# DI & Providers

‎docs/docs/response-filter.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Documentation over response filters provided by Ts.ED framework. Use class to transform data before returning it to your consumer.
5-
- name: keywords
6-
content: response filter ts.ed express typescript node.js javascript decorators jsonschema class models
2+
head:
3+
- - meta
4+
- name: description
5+
content: Documentation over response filters provided by Ts.ED framework. Use class to transform data before returning it to your consumer.
6+
- - meta
7+
- name: keywords
8+
content: response filter ts.ed express typescript node.js javascript decorators jsonschema class models
79
---
810

911
# Response Filter

‎docs/docs/serve-files.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
meta:
3-
- name: description
4-
content: Serve statics files with Ts.ED by using decorators. Ts.ED is built on top of Express/Koa and use TypeScript language.
5-
- name: keywords
6-
content: ts.ed express typescript statics files node.js javascript decorators
2+
head:
3+
- - meta
4+
- name: description
5+
content: Serve statics files with Ts.ED by using decorators. Ts.ED is built on top of Express/Koa and use TypeScript language.
6+
- - meta
7+
- name: keywords
8+
content: ts.ed express typescript statics files node.js javascript decorators
79
---
810

911
# Serve files

0 commit comments

Comments
 (0)