forked from cerc-io/snowballtools-base
57599b4542
Bump node v in docs workflow fix(docs): treat warnings as errors false fix(docs)Correct docs pattern in gitignore Add target branch to docs build fix(docs)Correct docs pattern in gitignore Add target branch to docs build Add target branch to docs build
45 lines
1.1 KiB
JavaScript
45 lines
1.1 KiB
JavaScript
import { OptionDefaults } from 'typedoc';
|
|
|
|
const config = {
|
|
$schema: 'https://typedoc.org/schema.json',
|
|
entryPoints: [
|
|
'./packages/**/src/**/*.{ts,tsx}',
|
|
// './packages/frontend/src/**/*.{ts,tsx}',
|
|
// './packages/backend/src/**/*.{ts,tsx}',
|
|
// './packages/gql-client/src/**/*.{ts,tsx}',
|
|
],
|
|
entryPointStrategy: 'expand',
|
|
out: './docs',
|
|
plugin: ['typedoc-plugin-markdown'],
|
|
// plugin: ['typedoc-unhoax-theme'],
|
|
readme: './README.md',
|
|
mergeReadme: true,
|
|
name: 'Laconic Deploy FE API Documentation',
|
|
includeVersion: true,
|
|
githubPages: true,
|
|
searchInComments: true,
|
|
enumMembersFormat: 'table',
|
|
parametersFormat: 'table',
|
|
propertiesFormat: 'table',
|
|
typeDeclarationFormat: 'table',
|
|
indexFormat: 'table',
|
|
useCodeBlocks: true,
|
|
expandObjects: true,
|
|
textContentMappings: {
|
|
'breadcrumbs.home': 'Home',
|
|
},
|
|
validation: {
|
|
notDocumented: false,
|
|
invalidLink: false,
|
|
notExported: true,
|
|
},
|
|
skipErrorChecking: true,
|
|
tsconfig: './tsconfig.doc.json',
|
|
gitRevision: 'qrigin/develop-qwrk',
|
|
gitRemote: 'qrigin',
|
|
|
|
blockTags: [...OptionDefaults.blockTags, '@component', '@description'],
|
|
};
|
|
|
|
export default config;
|