Release Notes
2026-11-06
-
Added a read-only REST API. Beacon now publishes every documentation page and the navigation as JSON files under
/api/v1/, generated at build time, along with an OpenAPI description. See REST API. -
Added generated API reference pages. Add an OpenAPI 3 file to
content/, and Beacon builds a page for each endpoint with its parameters, responses, and code samples in cURL, JavaScript, and Python. See Generate an API Reference. -
Added a reference page for each REST API endpoint, listed in the sidebar by section with its HTTP method. Generated API reference endpoints now join a navigation group titled API Reference if your site has one. See Generate an API Reference.
-
Added nested navigation items. Add a
childrenarray to an item incontent/nav.config.tsto nest pages under it in the sidebar. See Write Documentation Pages.
2026-11-02
- Added Markdown mirrors. Beacon now publishes every documentation page as plain
Markdown at the page URL plus
.md, such as/quickstart.md, with/index.mdfor the home page. The mirrors convert components likeCalloutandStepsto standard Markdown and make links absolute./llms.txtnow links to the Markdown versions.
2026-10-15
-
Added support for your own product logo. Add an image file named
logoto thecontent/folder, such ascontent/logo.svg, to show it in the top bar in place of the Beacon logo. Addcontent/logo-dark.*to show a different logo in dark mode. See Author Documentation Pages. -
Added
ImageandVideocomponents for adding images and videos to documentation pages. Put the files incontent/media/and insert them with<Image src="..." alt="..." />or<Video src="..." title="..." />, with an optional caption. Markdown image syntax works withcontent/media/files too. See Authoring Components.
2026-10-14
-
Added custom documentation variables. Define your own variables as names and string values in
content/variables.json, and use them in pages the same way as the built-inproductNameandprojectNamevariables. To show a variable name as literal text, put a backslash in front of it. See Authoring Components. -
Added
StepsandStepcomponents (src/components/docs/Steps.tsx) for numbered procedures in documentation content. Each step shows a numbered badge, a title, and a connecting line to the next step, and numbers itself automatically. They're registered as global MDX components, so any.mdxfile can use<Steps>and<Step title="...">without an import statement. See Authoring Components.
2026-10-13
-
Added a
NEXT_PUBLIC_PRODUCT_NAMEenvironment variable for the name of the product your documentation describes. It sets the top bar, page titles, and theproductNamedocumentation variable, and falls back toMyProductif unset. See Deploy. -
Added an
.env.examplefile that lists the environment variables you can set. It doesn't include keys, secrets, or tokens.
2026-08-12
- Added the
Calloutcomponent (src/components/docs/Callout.tsx) for note, tip, important, and warning admonitions in documentation content. It's registered as a global MDX component, so any.mdxfile can use<Callout type="warning">...</Callout>directly without an import statement.
2026-08-05
- Added a GitHub webhook that triggers when a PR merges into
maintouchingcontent/docs/**/*.mdxorcontent/nav.config.ts. It checks whether other documentation pages are now stale and writes suggestions to Vercel Blob storage for manual review. See Check for Drift for details.