Skip to content
 
 

Repository files navigation

TBMQ Docs

Source for tbmq.io — the website and documentation for TBMQ, the open-source MQTT broker by ThingsBoard. Built with Astro and Starlight.

Quickstart

Prerequisites: Node.js (any recent LTS) and pnpm.

pnpm install
pnpm dev          # http://localhost:4321/
pnpm build:fast   # production build, skips OG image generation

Repo layout

  • src/content/docs/ — documentation pages (Markdown / MDX)
  • src/content/_includes/ — shared content reused across product variants (CE / PE)
  • src/pages/ — marketing and landing pages
  • astro.sidebar.ts — docs navigation tree
  • src/data/redirects.ts — redirect source of truth (run pnpm generate:redirects after editing)
  • public/ — static assets and the generated redirect rules

See CLAUDE.md for the full content architecture reference.

Contributing

See CONTRIBUTING.md for setup, the CI checks, content authoring conventions, and a playbook for common contributor tasks.

Links

License

Licensed under the terms in LICENSE.

About

Documentation repository for TBMQ

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages