@exellix/neo-tools-docs
v0.1.1
Published
neo-tools product docs knowledge SDK (docify). Install / use as a workspace CLI — not a production worker dependency.
Readme
@exellix/neo-tools-docs
neo-tools product docs library on x12i docify. Workspace knowledge SDK + local human site — not a production worker dependency.
# from repo root
npm run docs:neo-tools -- list-use-cases
npm run docs:neo-tools -- use-case orient-neo-tools
npm run docs:neo-tools -- book 00-overview developers
# human site (builds bundle if needed)
npm run docs -w @exellix/neo-tools-docsimport { neoToolsDocs } from "@exellix/neo-tools-docs";
neoToolsDocs.listUseCases();
neoToolsDocs.getUseCaseMarkdown("run-local-stack");
neoToolsDocs.getBookMarkdown("02-production", "developers");Author content under data/, site-pages/, and NN-slug/{audience}/BOOK.md. Rebuild with npm run build -w @exellix/neo-tools-docs.
Built on the docify 1.1.x framework: docify.config.json marks the library root, the build uses buildDocifyLibrary + assembleWebTree + injectServeGuard from @x12i/docify-export, and data/sequences.json defines the start-to-finish journey. Validate structure, links, and chapter slugs with:
npm run validate -w @exellix/neo-tools-docs # docify validate .Release
Knowledge SDK (npmjs):
# use an isolated userconfig so a home ~/.npmrc scope map cannot divert the publish
npm publish -w @exellix/neo-tools-docs --access public --userconfig .npmrc
# → @exellix/neo-tools-docs on https://registry.npmjs.org/Human site (Cloudflare Pages): Wrangler OAuth must already be approved (docify publish connect / wrangler login). Project docs-neo-tools → https://docs.neo-tools.exellix.com.
npm run build -w @exellix/neo-tools-docs
cd neo-tools-docs
npx docify publish --config docify.config.json
# if the CLI swallows wrangler output on Windows, fall back to:
# CLOUDFLARE_ACCOUNT_ID=f3ad7fe7ee103c7d02672f012aefb100 \
# npx wrangler pages deploy dist/web --project-name docs-neo-tools --branch main --commit-dirty=true