@shadow-shard-tools/docs-html-generator
v0.1.2
Published
Static HTML generator for SST Docs content.
Maintainers
Readme
SST Docs HTML Generator Module
Reusable static HTML generator used by SST Docs.
Usage
- Install dependencies and build assets in your docs project so the generator can copy compiled CSS from
dist/assets. - Provide docs JSON data root (defaults to
public/SST-Docs/data). - Run via CLI:
npx sst-docs-html --data ./public/SST-Docs/data --out ./dist-static
Programmatic usage:
import { generateStaticHtml } from "@shadowshard/docs-html-generator";
await generateStaticHtml({
dataRoot: "./public/SST-Docs/data",
outDir: "./dist-static",
basePath: "/",
});Development
npm run buildemits ESM output indist/(bundled viatsc).- The CLI entry point is published as
sst-docs-htmland mirrors the existing flags from the monorepo script. - Chart rendering uses
chartjs-node-canvas; ensure native dependencies are available in your runtime.
