Skip to content

Configuration

Loads and provides configuration for documentation generation.

4 exports Added in v0.6.0 Source

Constants

DEFAULT_THEME

Added in v0.6.0 Source

Default GitHub Pages theme written to generated configuration.

Signature

declare const DEFAULT_THEME: "mikearnaldi/just-the-docs";

Schemas

ConfigurationSchema

Added in v0.6.0 Source

Schema for docgen configuration files.

Signature

declare const ConfigurationSchema: Struct<{
  readonly $schema: optional<String>;
  readonly enableSearch: optional<Boolean>;
  readonly enforceDescriptions: optional<Boolean>;
  readonly enforceExamples: optional<Boolean>;
  readonly enforceVersion: optional<Boolean>;
  readonly examplesCompilerOptions: optional<Union<readonly [String, $Record<String, Unknown>]>>;
  readonly exclude: optional<$Array<String>>;
  readonly outDir: optional<String>;
  readonly parseCompilerOptions: optional<Union<readonly [String, $Record<String, Unknown>]>>;
  readonly projectHomepage: optional<String>;
  readonly runExamples: optional<Boolean>;
  readonly srcDir: optional<String>;
  readonly srcLink: optional<String>;
  readonly theme: optional<String>;
  readonly tscExecutable: optional<String>;
}>;

Services

Configuration

Added in v0.6.0 Source

Service that provides resolved docgen configuration.

Signature

declare class Configuration extends Shape<
  "@effect/docgen/Configuration",
  ConfigurationShape,
  this
> {
  constructor(_: never);
}

ConfigurationShape interface

Added in v0.6.0 Source

Resolved configuration used by the docgen services.

Signature

interface ConfigurationShape {
  readonly enableSearch: boolean;
  readonly enforceDescriptions: boolean;
  readonly enforceExamples: boolean;
  readonly enforceVersion: boolean;
  readonly examplesCompilerOptions: Record<string, unknown>;
  readonly exclude: readonly Array<string>;
  readonly outDir: string;
  readonly parseCompilerOptions: Record<string, unknown>;
  readonly projectHomepage: string;
  readonly projectName: string;
  readonly runExamples: boolean;
  readonly srcDir: string;
  readonly srcLink: string;
  readonly theme: string;
  readonly tscExecutable: string;
}