Skip to content

Commit

Permalink
docs: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed May 20, 2019
1 parent 562b18a commit eca27b1
Show file tree
Hide file tree
Showing 108 changed files with 1,916 additions and 1,437 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,12 @@ index.js.map
packages/**/*.js
packages/**/*.js.map
packages/**/*.d.ts
packages/**/*.d.ts.map
packages/**/lib
test/**/*.js
test/**/*.js.map
test/**/*.d.ts
test/**/*.d.ts.map
.npmrc

# Test
Expand All @@ -65,4 +67,4 @@ test/**/*.d.ts

/.nyc_output/
/test/integration/app/spec/swagger.json
/docs/.vuepress/dist
/docs/.vuepress/dist
110 changes: 61 additions & 49 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ module.exports = {
apiKey: "f8a038207e461aaac0e2fd16403c2b01",
indexName: "ts_ed"
},

locales: {
"/": {
label: "English",
Expand All @@ -38,6 +39,35 @@ module.exports = {
text: "Configuration",
link: "/configuration.html"
},
{
text: "Docs",
items: [
{
text: "Overview",
items: [
{link: "/docs/controllers.html", text: "Controllers", items: []},
{link: "/docs/providers.html", text: "Providers"},
{link: "/docs/model.html", text: "Models"},
{link: "/docs/converters.html", text: "Converters"},
{link: "/docs/middlewares.html", text: "Middlewares"},
{link: "/docs/filters.html", text: "Filters"},
{link: "/docs/interceptors.html", text: "Interceptors"},
{link: "/docs/authentication.html", text: "Authentication"},
{link: "/docs/server-loader.html", text: "ServerLoader"}
]
},
{
text: "Advanced",
items: [
{link: "/docs/injection-scopes.html", text: "Injection scopes"},
{link: "/docs/custom-providers.html", text: "Custom providers"},
{link: "/docs/custom-endpoint-decorators.html", text: "Custom endpoint decorators"},
{link: "/docs/testing.html", text: "Testing"},
{link: "/api.html", text: "Api Reference"}
]
}
]
},
{
text: "Guide",
type: "links",
Expand All @@ -59,28 +89,6 @@ module.exports = {
{link: "/tutorials/not-found-page.html", text: "Customize 404"},
{link: "/tutorials/aws.html", text: "AWS project"}
]
},
{
text: "Documentation",
items: [
{link: "/docs/controllers.html", text: "Controllers"},
{link: "/docs/services.html", text: "Services"},
{link: "/docs/factory.html", text: "Factory"},
{link: "/docs/provider.html", text: "Provider"},
{link: "/docs/model.html", text: "Models"},
{link: "/docs/converters.html", text: "Converters"},
{link: "/docs/middlewares.html", text: "Middlewares"},
{link: "/docs/scope.html", text: "Scope"},
{link: "/docs/filters.html", text: "Filters"},
{link: "/docs/interceptors.html", text: "Interceptors"},
{link: "/docs/authentication.html", text: "Authentication"},
{link: "/docs/server-loader.html", text: "ServerLoader"},
{link: "/docs/testing.html", text: "Testing"}
]
},
{
text: "Api Reference",
link: "/api.html"
}
],

Expand All @@ -89,10 +97,6 @@ module.exports = {
title: "Middlewares",
collapsable: false,
children: [
"global-middleware",
"global-error-middleware",
"endpoint-middleware",
"endpoint-error-middleware",
"call-sequence",
"override-middleware",
"override/authentication",
Expand All @@ -102,25 +106,33 @@ module.exports = {
]
}],

"/docs/": [{
title: "Documentation",
collapsable: false,
children: [
"controllers",
"services",
"factory",
"provider",
"model",
"converters",
"middlewares",
"scope",
"filters",
"interceptors",
"authentication",
"server-loader",
"testing"
]
}],
"/docs/": [
{
title: "Overview",
collapsable: false,
children: [
"controllers",
"providers",
"model",
"converters",
"middlewares",
"filters",
"interceptors",
"authentication",
"server-loader"
]
},
{
title: "Advanced",
collapsable: false,
children: [
"injection-scopes",
"custom-providers",
"custom-endpoint-decorators",
"testing"
]
}
],


"/tutorials/": [{
Expand Down Expand Up @@ -166,17 +178,17 @@ module.exports = {
"/tutorials/aws",
"/tutorials/seq",
"/docs/controllers",
"/docs/services",
"/docs/factory",
"/docs/provider",
"/docs/providers",
"/docs/model",
"/docs/converters",
"/docs/middlewares",
"/docs/scope",
"/docs/filters",
"/docs/interceptors",
"/docs/authentication",
"/docs/server-loader",
"/docs/injection-scopes",
"/docs/custom-providers",
"/docs/custom-endpoint-decorators",
"/docs/testing"
],

Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/public/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -5334,4 +5334,4 @@
"name": "@tsed/socketio"
}
}
}
}
Binary file added docs/assets/client-controllers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/providers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit eca27b1

Please sign in to comment.