@ankhorage/paradox

Deterministic documentation generator for TypeScript packages.

Usage

CLI

Ankhorage packages expose their command-line interface through ankh. Use ankh --help to discover available package commands, or run a package command with --help for package-specific usage.

# Install the Ankhorage CLI
bun add --global @ankhorage/ankh

# Show usage information for paradox
ankh paradox --help

Basic Usage

Paradox generates documentation from the canonical package structure. Usage documentation lives only below examples/** or src/cli/**. A repository may contain multiple @usage examples, but exactly one example below examples/** is promoted into README with @readme.

README-promoted usage provides an explicit @title and non-empty prose. Code always comes from real source declarations rather than duplicated code blocks inside Paradox comments.

export const basicConfig = defineParadoxConfig({
  mode: 'safe',
});

Configuration

Configures Paradox documentation generation for a package.

| Field | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | mode | 'safe' \| 'write' \| undefined | no | — | | | collaborators | true \| undefined | no | — | | | donation | { account: string; } \| undefined | no | — | | | docs | { title?: string; description?: string; } \| undefined | no | — | | | package | { root?: string; entrypoints?: string[]; } \| undefined | no | — | | | output | { dir?: string; } \| undefined | no | — | |

Generated documentation

• Interactive documentation app
• Public API reference
• Component registry
• Architecture overview
• Module relationships
• Export graph
• isParadoxDocTagName sequence
• paradox sequence

Public API

Config

defineParadoxConfig(config: ParadoxConfig) => ParadoxConfig

Defines a Paradox configuration object without changing its shape.

Module: src/config/defineParadoxConfig.ts Source: src/config/defineParadoxConfig.ts:8:1 Related symbols: ParadoxConfig

Documentation

Supported Paradox documentation tags projected from the canonical documentation Rules provider.

Module: src/doc-tags/registry.ts Source: src/doc-tags/registry.ts:33:14

Types

Configures Paradox documentation generation for a package.

Module: src/types/config.ts Source: src/types/config.ts:9:1

Collaborators

Donation

If this project is useful to you, you can support its continued development.

Support @ankhorage