SteleDocs
GuidesOverview

Stele User Guide

Stele publishes rendered Markdown, HTML, and React components directly from your GitHub repository. Push your content and it's live — no build steps, no deploy buttons.

Guides

  • Getting Started — Onboard a repository and publish your first site
  • Content Formats — Markdown, HTML, React/TSX, and generated diagrams (LikeC4, D2) — what's supported and how each renders
  • React Components — Write interactive components with the built-in React runtime
  • Configuration Reference — Customise your site with .stele.yml
  • Sharing & Access — The four access values (only invited people, everyone at Axelerant, Axelerant and invited people, anyone with the link), how settings combine, inviting people by email, share links, and revoking access
  • Roles — The four roles, what each allows on your own sites and on any site, the Roles page, and making the first admin
  • Navigation & Structure — URLs, landing pages, linking, sidebar, and file browser
  • Themes — The default and guide looks, choosing one per folder, the guide's sidebar and how to curate it, callouts, and using the guide theme in hand-written HTML
  • Collections — Folders of ADRs, runbooks or audit findings that Stele lists for you: the frontmatter each type reads, relations between items, and runbook alerts
  • Ask — An assistant that answers questions from your documents, with citations: the ask: block, what it can read, who may ask, and what the site owner sets in the portal
  • Give your agent the Stele skill — Install the stele-resources agent skill so your coding agent already knows the conventions before it touches your repo
  • Connect your agent to Stele — Add Stele's MCP server to Claude Code or claude.ai so an agent can fetch live links to what it pushed, onboard repositories, and keep viewer lists

The short version

  1. Sign in at stele.axelerant.tech with your Axelerant Google account
  2. Add a repository
  3. Your site is live at https://<slug>.stele.axelerant.tech
  4. Push changes to update — the site syncs within 60 seconds
  5. Optionally add a .stele.yml to customise behaviour

No configuration is required for the common case. A repo with a README.md is already a working site.