@suluk/docs - v0.1.4
    Preparing search index...

    Interface HarvestOptions

    @suluk/docs — generate an intuitive static documentation site for a Bun/TS monorepo, straight from source (package.json + the leading doc-comments + exports + ARCHITECTURE/README). The output is plain HTML + one stylesheet, deployable to GitHub Pages with zero build. Suluk documents itself with it. CANDIDATE tooling.

    interface HarvestOptions {
        packagesDir: string;
        title: string;
        tagline: string;
        description: string;
        repoUrl: string;
        architecturePath?: string;
        repoRoot?: string;
        excludePrivate?: boolean;
    }
    Index

    Properties

    packagesDir title tagline description repoUrl architecturePath? repoRoot? excludePrivate?

    Properties

    packagesDir: string
    title: string
    tagline: string
    description: string
    repoUrl: string
    architecturePath?: string
    repoRoot?: string

    Repo root — when given, each package's README links resolve against its path from here (→ GitHub blob URLs).

    excludePrivate?: boolean

    Exclude private/example packages from the public docs (default false — include them, flagged).

    Settings

    Member Visibility

    On This Page

    Properties