@fred3d/typedoc-config

Shared TypeDoc configuration for Fred3D packages.

Usage

1. Add the package to your devDependencies:

{
  "devDependencies": {
    "@fred3d/typedoc-config": "workspace:*"
  }
}

2. Create a typedoc.json in your package:

{
  "$schema": "https://typedoc.org/schema.json",
  "extends": ["@fred3d/typedoc-config/base"],
  "entryPoints": ["./src/index.ts"],
  "out": "docs",
  "name": "Your Package Documentation",
  "readme": "README.md",
  "categoryOrder": [
    "Your Category 1",
    "Your Category 2",
    "*"
  ]
}

Or for markdown output:

{
  "$schema": "https://typedoc.org/schema.json",
  "extends": ["@fred3d/typedoc-config/markdown"],
  "entryPoints": ["./src/index.ts"],
  "out": "docs",
  "name": "Your Package Documentation"
}

What's Included

Base Configuration

• Standard visibility filters
• Exclusion of test files
• Alphabetical sorting
• Category/group navigation
• Comment searching

Markdown Configuration

• All base settings
• Markdown theme
• typedoc-plugin-markdown integration