@basemachina/minidoc
v0.1.1
Published
A minimal MDX documentation generator with built-in diagrams, preview, static hosting, CLI, and agent skill support.
Keywords
Readme
minidoc
Minimal MDX documentation with built-in diagrams, static output, a preview app, a CLI, and installable agent skills.
npx @basemachina/minidoc init minidocs
npx @basemachina/minidoc dev minidocs
npx @basemachina/minidoc build minidocs
npx @basemachina/minidoc skill install --agent codex --scope global
npx @basemachina/minidoc skill install --agent claude --scope projectDocs source lives in minidocs/. Static output is written to minidocs/out/.
Publishing
The package is scoped and public. Releases are managed with Changesets:
pnpm changesetRelease flow
Create feature PRs against
develop.For every non-release PR, add a changeset:
pnpm changesetChoose
patch,minor, ormajor, then write the user-facing release note.If a PR should not publish a new package version, add an empty changeset:
pnpm changeset --emptyEmpty changesets are still consumed by the
Version PackagesPR, so non-release changes can move fromdeveloptomainwithout bumping npm.Merge approved feature PRs into
develop.Open the
Prepare releasebutton above, chooseRun workflow, and leavesource_branchasdevelopunless you are preparing from a temporary branch. The workflow reads pending changesets, updates versions and changelogs, and opens or updates theVersion PackagesPR intomain.Review and merge the
Version PackagesPR intomain. Thepublish npm packageworkflow publishes the new npm version, updates the npmlatestdist-tag, pushes the matchingvX.Y.ZGit tag, and creates the GitHub Release.
The changeset check workflow fails PRs to develop that change the package
without a changeset. main should only receive Version Packages release PRs.
The repository secret NPM_TOKEN must have publish access to the @basemachina
npm scope.
