Skip to content

Commit

Permalink
Merge pull request #895 from samchon/features/api
Browse files Browse the repository at this point in the history
API Documents by TypeDoc
  • Loading branch information
samchon committed May 3, 2024
2 parents 69e893a + 0515cbf commit c671c7a
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Nestia is a set of helper libraries for NestJS, supporting below features:
- SDK library generator for clients
- Mockup Simulator for client applications
- Automatic E2E test functions generator
- `@nestia/migrate`: Migration from Swagger to NestJS
- `@nestia/editor`: Online TypeScript Swagger Editor
- `@nestia/migrate`: OpenAPI generator from Swagger to NestJS
- `@nestia/editor`: Swagger-UI with Online TypeScript Editor
- `nestia`: Just CLI (command line interface) tool

> **Note**
Expand Down
3 changes: 2 additions & 1 deletion website/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.next
node_modules/
out/
out/
public/api/
6 changes: 6 additions & 0 deletions website/next.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,11 @@ const nextConfig = {
unoptimized: true,
},
output: "export",
rewrites: async () => [
{
source: "/api",
destination: "/api/index.html",
},
],
};
module.exports = nextConfig;
3 changes: 2 additions & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Nestia Guide Documents",
"private": true,
"scripts": {
"build": "rimraf .next && rimraf .out && next build && next-sitemap",
"build": "rimraf .next && rimraf .out && typedoc && next build && next-sitemap",
"deploy": "node deploy",
"dev": "next dev"
},
Expand Down Expand Up @@ -43,6 +43,7 @@
"gh-pages": "^5.0.0",
"next-sitemap": "^4.2.3",
"rimraf": "^5.0.0",
"typedoc": "^0.25.13",
"typescript": "^5.4.5"
}
}
5 changes: 5 additions & 0 deletions website/pages/docs/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
"type": "separator",
"title": "🔗 Appendix"
},
"api": {
"title": "API Documents",
"href": "/api",
"newWindow": false
},
"benchmark": {
"title": "⇲ Benchmark Result",
"href": "https://github.com/samchon/nestia/tree/master/benchmark/results/AMD%20Ryzen%209%207940HS%20w%20Radeon%20780M%20Graphics",
Expand Down
4 changes: 2 additions & 2 deletions website/pages/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ Nestia is a set of helper libraries for [NestJS](https://docs.nestjs.com), suppo
- SDK library generator for clients
- Mockup Simulator for client developers
- Automatic E2E test functions generator
- `@nestia/migrate`: Migration from Swagger to NestJS
- `@nestia/editor`: Online TypeScript Swagger Editor
- `@nestia/migrate`: OpenAPI generator from Swagger to NestJS
- `@nestia/editor`: Swagger-UI with Online TypeScript Editor
- `nestia`: Just CLI (command line interface) tool

<br/>
Expand Down
7 changes: 7 additions & 0 deletions website/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"tsconfig": "../packages/core/tsconfig.json",
"entryPoints": [
"../packages/core/src/index.ts",
],
"out": "./public/api"
}

0 comments on commit c671c7a

Please sign in to comment.