@x12i/countex-docs

Countex documentation knowledge SDK and Docify site bundle.

Install this package as a devDependency. It exposes the published Countex manuals as Docify books, guided use-case packs, and a local documentation site. The Markdown under packages/countex/docs remains the single source of truth.

Install

npm install --save-dev @x12i/countex-docs

SDK

import { countexDocs } from "@x12i/countex-docs";

countexDocs.listBooks();
countexDocs.listUseCases();
countexDocs.getBookMarkdown("00-getting-started", "developers");
countexDocs.getUseCaseMarkdown("build-a-first-counter");
countexDocs.manifest();

CLI

npx countex-docs list-books
npx countex-docs list-use-cases
npx countex-docs book 01-core-engine developers
npx countex-docs use-case deploy-with-mongo-and-redis

Local site

From this package:

npm run docs

This builds dist/bundle and the deployable dist/web tree, then serves dist/web with @x12i/docify-web on http://localhost:4173.

Useful variants:

npm run docs:serve    # serve without opening a browser
npm run docs:rebuild  # force a knowledge rebuild, then serve

Source layout

| Path | Role | |------|------| | content/catalog.json | Book catalog metadata | | content/use-cases.json | Task-focused reading paths | | content/site.json | Site brand and navigation | | content/site-pages/ | Docify site pages | | scripts/build-knowledge.mjs | Assemble books from @x12i/countex docs and build the SDK bundle | | src/ | Published SDK and CLI entrypoints |

Canonical documentation sources:

• packages/countex/README.md
• packages/countex/docs/**/*.md

Build

npm run build
npm test