@x12i/connectix-docs

Connectix knowledge SDK (agents) plus a deployable dist/web static site (humans).

Install as a devDependency only — do not add to production service dependencies.

npm i -D @x12i/connectix-docs

Knowledge SDK (agents)

import { connectixDocs } from "@x12i/connectix-docs";

connectixDocs.getUseCaseMarkdown("orient-connectix");
connectixDocs.getBookMarkdown("01-tools-and-simulator", "developers");
connectixDocs.manifest();

CLI:

npx connectix-docs list-use-cases
npx connectix-docs use-case call-connect-tools > pack.md
npx connectix-docs book 00-orient-connectix developers > book.md

| Use case id | Goal | |-------------|------| | orient-connectix | Understand the service, the four curated operations, and the caller contract | | call-connect-tools | Expose Connectix as LLM tools via @x12i/connectix-tools | | run-package-simulator | Develop against @x12i/connectix-simulator deterministic fixtures | | catalog-extension-overview | Understand OpenConnector / n8n-node / Nango-derived provenance |

Deployable web site (dist/web)

After install (or after npm run docs:web in this repo), deploy the static tree:

node_modules/@x12i/connectix-docs/dist/web/

It contains index.html, docs.html, book landings, read.html, catalog.json, use-cases.json, agent-manifest.json, downloads/, and themed assets — ready for any static host (nginx, S3, Cloudflare Pages, Netlify, …).

Locally:

# from the Connectix monorepo
npm run docs:web          # build dist/web
npm run docs:serve        # serve on :4173 via @x12i/docify-web

Or after installing the published package:

npx docify-web serve node_modules/@x12i/connectix-docs/dist/web --port 4173

Build pipeline (authors)

Content lives under content/ (data/*.json, site-pages/*.md, NN-slug/<audience>/BOOK.md).

| Script | Job | |--------|-----| | npm run docs:web | buildContentBundle + @x12i/docify-web shell → dist/web | | npm run docs:knowledge | Embed downloads into src/generated/bundle.ts | | npm run bundle | web + knowledge | | npm run build | TypeScript knowledge SDK (prebuild runs bundle) |

Set DOCIFY_PDF=0 to skip PDF generation when wkhtmltopdf is unavailable.

Depends on published @x12i/docify-{core,sdk,export,render,theme,web}.

License: UNLICENSED (X12I internal; published for X12I service consumers).