@doxbrix/doxloop-generator-markdoc
v0.1.0
Published
Markdoc generator adapter and authoring skill for Doxloop.
Readme
@doxbrix/doxloop-generator-markdoc
Markdoc support for Doxloop. This package
connects Doxloop to a native Markdoc documentation project and includes the
doxloop-markdoc authoring skill used by supported coding agents.
Install
Install the Doxloop CLI and this generator in your documentation project:
npm install --save-dev \
@doxbrix/doxloop \
@doxbrix/doxloop-generator-markdocNode.js 20.12 or later is required.
Create documentation
Initialize a Markdoc documentation project and connect the product source that Doxloop should research:
npx doxloop init . \
--source product=../my-product \
--generator markdoc
npx doxloop createDoxloop scaffolds Markdoc configuration, content, generator-native navigation, and the project-local authoring skill.
Use with an existing project
Install Markdoc support in an existing Doxloop project with:
npx doxloop generator add markdocAdding the package does not convert existing content or change the generator
selected in .doxloop/project.json.
Preview and verify
npx doxloop preview --open
npx doxloop test
npm run build| Detail | Value |
| --- | --- |
| Content | Markdoc (.md) |
| Native build | npm run build |
| Build output | dist/ |
Run npx doxloop generator info markdoc to inspect the installed adapter.
