Skip to main content

Follow the latest changes to Relevate. These notes focus on what documentation authors and readers can see and use.

Bug fixes Improvements New releases

New releases

  • Oxide theme: A cleaner theme with configurable colors, backgrounds, logos, and appearance. Customize Oxide.

  • React components: Add interactive React islands to MDX and style them with Tailwind CSS. View examples.

  • GraphQL references: Generate operation and schema pages with arguments, return types, examples, links, and deprecations.

  • TypeScript references: Turn TypeDoc output into navigable overview and symbol pages.

  • Link checker: Run relevate check-links to validate links, anchors, navigation entries, and local assets across Markdown, MDX, and JSX files.

  • Personalization preview: Test conditional documentation with local user fixtures. This remains a work in progress. Learn more.

  • Personalized API examples: Prefill playground headers, parameters, servers, and authentication for each reader.

  • Reusable components: Compose pages from shared MDX snippets and interactive React components.

Improvements

  • Custom component styles: Add Tailwind utilities through className; conflicting defaults are replaced while the rest of the component styling stays intact. Style components.

  • Conditional MDX: Use <MDX> for headings, lists, tables, code blocks, and components inside personalized branches. See conditional MDX.

  • Syntax highlighting: Preview the full language set consistently across macOS, Linux, and Windows.

  • Markdown and MDX: Mix both formats in one project and link between them with natural source paths.

  • Text exports: Retrieve published pages as clean Markdown or plain text. Explore content formats.

  • Agent discovery: Expose a generated or custom skill.md alongside agent-friendly page content.

  • OpenAPI references: Resolve local, remote, and multiple specifications, including webhooks and schemas.

  • Localized navigation: Keep translated labels, routes, search, and language switching aligned.

Bug fixes

  • Shared links now include generated Open Graph images.

  • Sidebar pages retain the correct product-feature groups and section labels.

  • Windows preview resolves the documentation source from the correct project path.

  • npm installs select matching CLI and platform packages consistently.

  • Syntax-highlighting caches refresh correctly when the highlighter changes.

  • MDX component examples now highlight JSX tags, properties, and values instead of appearing as plain text.

  • Managed documentation receives newly compiled artifacts more reliably after an update.