The OpenElectricity project (formerly OpenNEM) aims to make the wealth of public Australian energy data more accessible to a wider audience. Project homepage at openelectricity.org.au.
This repo holds the source for the documentation, live at https://docs.openelectricity.org.au, built with Tangly (GitHub), a self-hosted, open-source docs framework that renders a Mintlify-style docs.json unmodified. Pages are MDX; navigation, theme, and the API reference are configured in docs.json.
Requires bun (Node 19+).
bun install
bun run dev # http://localhost:9411 (override with PORT)bun run build # static build -> ./dist
bun run preview # serve ./dist locally
bun run check # tangly check --strict (config, nav, links, frontmatter)| Path | What |
|---|---|
docs.json | Site config: nav, theme, colors, API reference. See the Tangly docs for options. |
*.mdx, guides/, sdk/, howto/, platform/, contribute/ | Documentation pages |
api-reference/ | OpenAPI-driven API pages |
images/ | Static assets, served from /images/... |
API reference pages read the spec from docs.json (api.openapi). TANGLY_OPENAPI_URL overrides it at build time. Preview builds use the dev API (https://api.oedev.org/openapi.json); production uses the default in docs.json.
Edits and new pages are welcome. See CONTRIBUTING.md for the full guide. In short:
- Branch, edit or add an
.mdxpage, and wire it intodocs.jsonnavigation. bun run checkto validate;bun run devto preview locally.- Open a PR. CI builds a preview deployment and comments the URL.
- On merge to
main, the site deploys automatically to production.
For component syntax, frontmatter, and config options, see the Tangly documentation.
Push-to-deploy via Cloudflare Pages (GitHub Actions):
- Pull requests ->
.github/workflows/preview.ymlbuilds a preview and comments the URL. main->.github/workflows/deploy.ymlbuilds and deploys to docs.openelectricity.org.au.
Deploys require CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID as repository secrets.
MIT. Part of the Open Electricity project.