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

    Interface PackageDoc

    @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 PackageDoc {
        name: string;
        slug: string;
        description: string;
        version: string;
        private: boolean;
        dependencies: string[];
        peerDependencies: string[];
        overview: string;
        readme: string;
        repoRelDir: string;
        exports: string[];
        modules: ModuleDoc[];
    }
    Index

    Properties

    name slug description version private dependencies peerDependencies overview readme repoRelDir exports modules

    Properties

    name: string
    slug: string
    description: string
    version: string
    private: boolean
    dependencies: string[]
    peerDependencies: string[]
    overview: string

    Markdown prose from the leading /** */ doc-comment of src/index.ts.

    readme: string

    The package's README.md, verbatim (the hand-written usage docs), or "" if it has none.

    repoRelDir: string

    The package directory relative to the repo root (e.g. tooling/ts/packages/core) — used to rewrite README links.

    exports: string[]

    Public symbols re-exported from the barrel.

    modules: ModuleDoc[]

    Per-module leading doc-comments.

    Settings

    Member Visibility

    On This Page

    Properties