marmotte

Appearance

marmotte / vite/typedoc

vite/typedoc ​

Type Aliases ​

Options ​

Options = Partial<BootstrapOptions> & object

Defined in: src/vite/typedoc.ts:15

Type Declaration ​

gitignore? ​

optional gitignore: boolean

Write a .gitignore containing * inside the TypeDoc output directory so that generated Markdown files are excluded from git automatically.

Default ​
ts
true
onGenerated()? ​

optional onGenerated: () => void | Promise<void>

a hook to call custom logic after files are generated

Returns ​

void | Promise<void>

Variables ​

defaultPlugins ​

const defaultPlugins: (app) => Promise<void>[]

Defined in: src/vite/typedoc.ts:6

Parameters ​

app ​

Application

Returns ​

Promise<void>

Functions ​

bootstrapTypeDoc() ​

bootstrapTypeDoc(options): Promise<Application>

Defined in: src/vite/typedoc.ts:47

Bootstrap a TypeDoc application generating an API reference into <docsRoot>/reference/api/. Override with the out TypeDoc option to change the output path.

Parameters ​

options ​

BootstrapOptions

Returns ​

Promise<Application>

TypeDocPlugin() ​

TypeDocPlugin(options?): object

Defined in: src/vite/typedoc.ts:87

Vite plugin that generates a TypeDoc API reference as Markdown files.

  • Build mode: kicks off TypeDoc in buildStart (fire-and-forget) so it runs concurrently with Vite's transforms; the result is awaited in buildEnd before VitePress runs in closeBundle.
  • Build watch mode (vite build --watch): starts TypeDoc in watch mode alongside Vite.
  • Dev mode (vite dev): starts TypeDoc in watch mode so the API reference stays up-to-date while you iterate.
ts
// vite.config.ts
import { TypeDocPlugin } from "marmotte/vite/typedoc"
export default defineConfig({ plugins: [TypeDocPlugin()] })

Parameters ​

options? ​

Options = {}

Returns ​

object

name ​

name: string = "marmotte:typedoc"

buildEnd() ​

buildEnd(this, error?): Promise<void>

Parameters ​
this ​

PluginContext

error? ​

Error

Returns ​

Promise<void>

buildStart() ​

buildStart(this): Promise<void>

Parameters ​
this ​

PluginContext

Returns ​

Promise<void>

configResolved() ​

configResolved(this, resolvedConfig): Promise<void>

Parameters ​
this ​

MinimalPluginContextWithoutEnvironment

resolvedConfig ​

ResolvedConfig

Returns ​

Promise<void>

configureServer() ​

configureServer(this): Promise<void>

Parameters ​
this ​

MinimalPluginContextWithoutEnvironment

Returns ​

Promise<void>

References ​

default ​

Renames and re-exports TypeDocPlugin