The content and configuration powering the documentation available at docs.gobl.org
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i mint -g
Run the following command at the root of your documentation (where mint.json is)
mint dev
Schema, catalogue, addon, and regime pages are produced by the internal Go
generator in cmd/generate. Schemas are read from the data.Content embedded
FS of the GOBL module pinned in go.mod, so no sibling checkout of the gobl
repo is required.
Addons come from multiple modules: core addons are bundled with GOBL itself,
while external addons (e.g. gobl.fr.ctc, gobl.sa.zatca) are pulled in via
the gobl.dev module's bundle package, which is the single curated list of
external addon modules. To document a newly approved external addon, update
github.com/invopop/gobl.dev in go.mod (the bundle import in
cmd/generate/main.go picks up whatever it declares) and regenerate.
To regenerate, run:
go build ./cmd/generate && ./generateThe generator wipes ./draft-0 on each run so schemas removed upstream don't
linger as orphaned pages. Treat the entire ./draft-0 directory as
generator-owned — don't hand-edit files under it, as any local changes will be
overwritten on the next regeneration. Per-addon pages under ./addons are
also generator-owned (stale ones are deleted automatically); only
addons/overview.mdx is hand-written.
After running the generator, double check that everything is linked to from the docs.json file.