@x12i/static-memorix-docs
v1.2.0
Published
Static Memorix Explorer API docs knowledge SDK for x12i-docify — install as a devDependency only. Catalog, guides, tutorials, and coding-agent instructions for humans and agents.
Maintainers
Readme
@x12i/static-memorix-docs
Static Memorix docs knowledge SDK for the x12i-docify platform. Install as a devDependency only — do not add to production service dependencies.
npm i -D @x12i/static-memorix-docsimport { staticMemorixDocs } from "@x12i/static-memorix-docs";
staticMemorixDocs.getUseCaseMarkdown("spin-up-a-mock-api");
staticMemorixDocs.getBookMarkdown("01-explorer-api", "developers");
staticMemorixDocs.manifest();CLI:
npx static-memorix-docs list-use-cases
npx static-memorix-docs use-case spin-up-a-mock-api > pack.md
npx static-memorix-docs book 01-explorer-api developers > book.mdHumans (local docs site)
From the monorepo root or this package:
npm run docs # build if needed, serve via docify, open browser (port 4173)
npm run docs:rebuild # force rebuild + serve
npm run docs:serve # serve without opening browser
npm run docs:verify # docify verify assets + package
npm run docs:publish # docify publish → Cloudflare Pages (docs.static-memorix.x12i.com)Built with latest @x12i/docify-* + @x12i/docify CLI (docify serve / docify publish).
What this package is
Authoring layout follows the docify product-library recipe:
data/{catalog,use-cases,site}.json— brand, books, use casessite-pages/*.md— marketing/docs routesNN-slug/{audience}/BOOK.md— assembled at build from canonical repo docs
npm run knowledge:build assembles each book's BOOK.md from
../../guides/, ../../tutorials/,
../../memorix-demo/,
../../code-agent-instructions/, and
../../packages/static-memorix-assistant/ai-assistants/,
then uses @x12i/docify-export (buildContentBundle, assembleWebTree,
injectServeGuard, verifyWebAssets) for the content bundle + dist/web,
and embeds open Markdown into src/generated/bundle.ts + files/ for the SDK.
Humans: deploy dist/web (Cloudflare via docify publish).
Agents: install this package / read files/ (INDEX.md, SEARCH.json, packs).
Build
npm run build # assemble books, bundle + web, compile the SDK
npm run knowledge:build # just re-assemble books + bundle + web + embed