examples

Examples

Sample documents you can publish to htmlbook to see each format in action.

File	Format	Notes
report.md	Markdown	A report with self-addressing frontmatter — publishes by itself
dashboard.html	hb-doc HTML	A themeable fragment: KPI cards, an inline SVG chart, a table
publish.sh	—	Pushes both via the REST API

Publish them

Set your key once, then run the script:

export HTMLBOOK_API_KEY="hb_live_xxxxxxxxxxxx"
./publish.sh

Or push one by hand:

# report.md self-addresses via frontmatter (project/slug/visibility live in the file)
curl -s -X POST "https://htmlbook.io/api/docs" \
  -H "Authorization: Bearer $HTMLBOOK_API_KEY" \
  --data-binary @report.md

# dashboard.html needs project/slug in the query
curl -s -X POST "https://htmlbook.io/api/docs?project=examples&slug=q3-dashboard" \
  -H "Authorization: Bearer $HTMLBOOK_API_KEY" \
  --data-binary @dashboard.html

See ../docs/publishing.md for the full pipeline.