-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypedoc.json
More file actions
20 lines (20 loc) · 1.21 KB
/
typedoc.json
File metadata and controls
20 lines (20 loc) · 1.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"entryPoints": ["src/**/*.ts"], // Entry point for your project, change accordingly
"exclude": ["src/browser/**/*"], // Exclude browser-specific files if any
"out": "docs", // Output directory for the generated documentation
"name": "Node CLI Adapter", // Project name used in the docs
"includeVersion": false, // Optional: Include project version in the output
"tsconfig": "./tsconfig.json", // Path to your TypeScript configuration
"theme": "default", // Use default or custom theme (custom themes can be pointed to by path)
"plugin": ["typedoc-plugin-markdown"], // Load plugins like Markdown support
"hideGenerator": true, // Hide the "Generated by TypeDoc" footer
"excludePrivate": true, // Exclude private members from the docs
"excludeProtected": false, // Optionally include or exclude protected members
"excludeExternals": true, // Exclude external modules
"disableSources": true, // Hide source links in the documentation
"readme": "none", // Don't generate README.md
"hidePageHeader": true, // Hide the page header
"hideGroupHeadings": true, // Hide the project name link in the header
"hideBreadcrumbs": true, // Hide breadcrumbs
"useCodeBlocks": true, // Use code blocks for code examples
}