sparkify
v0.2.3
Published
Mintlify-style static docs generator for GitHub Pages
Downloads
622
Maintainers
Readme
sparkify
sparkify is a static docs generator for Mintlify-style content.
Command name is sparkify (not sparify).
Requirements
- Node.js
>=20 - Python
3.10-3.12only when usingexport-openapi
Run Without Installing
npx sparkify --helpQuickstart
npx sparkify init
npx sparkify dev
npx sparkify build --site https://<user>.github.io --base /<repo>Commands
sparkify initsparkify devsparkify buildsparkify doctorsparkify export-openapi
FastAPI OpenAPI Export
npx sparkify export-openapi --fastapi "app.main:app" --out ./docs/openapi.jsonMore Documentation
- Project docs: https://github.com/spark-aiur/sparkify/tree/main/docs
- Issue tracker: https://github.com/spark-aiur/sparkify/issues
