@ankhorage/paradox

Deterministic documentation generator for TypeScript packages.

CLI

Generates deterministic documentation for a package through the Paradox CLI.

bunx @ankhorage/paradox

Runs the Paradox CLI.

The command discovers the nearest Paradox config, resolves the package and output roots, analyzes the package, builds the documentation model, renders all documentation artifacts, and writes them to the configured output directory.

Diagram: paradox sequence

sequenceDiagram
  participant participant_analyze as analyze
  participant participant_buildModel as buildModel
  participant participant_dirname as dirname
  participant participant_findParadoxConfigFile as findParadoxConfigFile
  participant participant_loadParadoxConfig as loadParadoxConfig
  participant participant_main as main
  participant participant_render as render
  participant participant_resolveOutputRoot as resolveOutputRoot
  participant participant_resolvePackageRoot as resolvePackageRoot
  participant participant_write as write
  participant_main->>participant_findParadoxConfigFile: findParadoxConfigFile()
  participant_findParadoxConfigFile-->>participant_main: return
  participant_main->>participant_dirname: dirname()
  participant_dirname-->>participant_main: return
  participant_main->>participant_loadParadoxConfig: loadParadoxConfig()
  participant_loadParadoxConfig-->>participant_main: return
  participant_main->>participant_resolvePackageRoot: resolvePackageRoot()
  participant_resolvePackageRoot-->>participant_main: return
  participant_main->>participant_resolveOutputRoot: resolveOutputRoot()
  participant_resolveOutputRoot-->>participant_main: return
  participant_main->>participant_analyze: analyze()
  participant_analyze-->>participant_main: return
  participant_main->>participant_buildModel: buildModel()
  participant_buildModel-->>participant_main: return
  participant_main->>participant_render: render()
  participant_render-->>participant_main: return
  participant_main->>participant_write: write()
  participant_write-->>participant_main: return

Configuration

Canonical Paradox configuration for this package.

import { defineParadoxConfig } from './src/config/defineParadoxConfig.js';

export default defineParadoxConfig({
  mode: 'write',

  docs: {
    title: '@ankhorage/paradox',
    description: 'Deterministic documentation generator for TypeScript packages.',
  },

  package: {
    entrypoints: ['src/index.ts'],
  },

  output: {
    dir: 'paradox',
  },
});

| Field | Type | Required | Default | Description | | ------- | ------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- | | mode | 'safe' \| 'write' \| undefined | no | — | | | docs | { title?: string; description?: string; usage?: { description?: string; entrypoints?: 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

Configuration for running Paradox.

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