mintfree
v0.0.1
Published
Build a static docs site from a Mintlify docs source directory.
Downloads
7
Readme
Mintfree CLI
Build a static docs site from a Mintlify docs source directory.
Requires Node.js 20+.
What it does
- Copies your Mintlify docs source into a temp workspace.
- Runs
@mintlify/prebuildagainst that workspace. - Converts prebuild output (
src/_props) into a rich static page manifest with navigation, search index, and heading metadata. - Renders pages using a swappable theme system (default:
mintlike) and reuses Mintlify components where practical. - Generates precomputed text files:
robots.txtsitemap.xmlllms.txtllms-full.txt
- Renders HTML through a prebundled standalone Next runtime and writes static output to
out/.
Usage
cd mintfree-cli
npm install
npx mintfree build ../docstestOptional base URL for sitemap/llms links:
npx mintfree build ../docstest --base-url https://docs.example.comOptional theme override:
npx mintfree build ../docstest --theme mintlikeThe static output is written to:
out/
Dev mode (watch + auto-reload)
cd mintfree-cli
npm install
npx mintfree dev ../docstest --port 3333This starts a local static server and rebuilds when docs/theme files change.
Rollup bundle
cd mintfree-cli
npm install
npm run bundleThis generates:
- a minified publishable CLI entry at
bin/mintfree.cjs - a prebuilt standalone Next runtime at
runtime/client/
The published package uses the standalone runtime, so Next app source folders are not required at runtime.
