api docs in separate folder

This commit is contained in:
evilsprut 2023-07-24 16:14:07 +03:00
parent f00c247a44
commit 1615ec6bd6
4 changed files with 3 additions and 12 deletions

1
.gitignore vendored
View File

@ -20,4 +20,5 @@ dist
# docs # docs
.vitepress/cache .vitepress/cache
docs-api

View File

@ -1,18 +1,10 @@
import { defineConfig } from 'vitepress' import { defineConfig } from 'vitepress'
import { typedocPlugin } from 'vuepress-plugin-typedoc/next';
// https://vitepress.dev/reference/site-config // https://vitepress.dev/reference/site-config
export default defineConfig({ export default defineConfig({
title: "NestJS Telegraf", title: "NestJS Telegraf",
description: "NestJS Telegraf documentation", description: "NestJS Telegraf documentation",
srcDir: './docs', srcDir: './docs',
plugins: [
typedocPlugin({
// plugin options
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.typedoc.json',
}),
],
themeConfig: { themeConfig: {
// https://vitepress.dev/reference/default-theme-config // https://vitepress.dev/reference/default-theme-config
nav: [ nav: [

View File

@ -72,10 +72,8 @@
"reflect-metadata": "0.1.13", "reflect-metadata": "0.1.13",
"telegraf": "4.12.2", "telegraf": "4.12.2",
"typedoc": "0.24.8", "typedoc": "0.24.8",
"typedoc-plugin-markdown": "^3.15.3",
"typescript": "4.8.2", "typescript": "4.8.2",
"vitepress": "^1.0.0-beta.6", "vitepress": "^1.0.0-beta.6"
"vuepress-plugin-typedoc": "^0.12.1"
}, },
"peerDependencies": { "peerDependencies": {
"@nestjs/common": "^9.0.0 || ^10.0.0", "@nestjs/common": "^9.0.0 || ^10.0.0",

View File

@ -5,6 +5,6 @@
}, },
"typedocOptions": { "typedocOptions": {
"entryPoints": ["./index.ts", "./lib"], "entryPoints": ["./index.ts", "./lib"],
"out": "docs" "out": "docs-api"
} }
} }