@octalmesh/seagull-docs
v0.1.1
Published
Seagull's documentation website generator.
Readme
Generates the documentation website from a bundled spec and serves it.
Published independently for anyone who wants only this piece. Most people should
install @octalmesh/seagull instead, which bundles this package
(and -core/-cli) into one.
import { loadConfig } from "@octalmesh/seagull-core";
import { generateDocsSite, serveDocsSite } from "@octalmesh/seagull-docs";
const config = loadConfig("./seagull.yaml");
await generateDocsSite(config); // writes dist/docs
const server = await serveDocsSite(config); // serves it, returns the Node http.Server for a programmatic shutdownEvery contract's bundled spec (paths.specFormat - json, yaml, or both)
is copied into dist/docs/specs/.
