Skip to content

v0.2.0

Choose a tag to compare

@github-actions github-actions released this 08 Jun 19:25
· 0 commits to 43d79602efad480258ad4145150d301ee88a5238 since this release

Highlights

This release is a broad compatibility-hardening pass: we ported six real-world Mintlify documentation sites (an OpenAPI reference, a legacy mint.json project, a multi-tab developer portal, a Mermaid/snippets-heavy site, and the official Mintlify docs) and closed every parity gap they surfaced.

  • OpenAPI with zero wiring. A root openapi.json / openapi.yaml / openapi.yml is now auto-discovered, so pages with openapi: "METHOD path" frontmatter render the full split-layout playground without any api.openapi config. (ce13ae4)
  • Anchors-as-navigation. A top-level navigation.anchors[] entry that wraps whole tabs/groups now resolves. Sites whose entire sidebar lives under an anchor previously rendered with an empty sidebar; now every page is reachable. (652d7fb)
  • Split your docs.json across files. JSON $ref includes ({ "$ref": "./redirects.json" }, per-language nav files) resolve before validation, with #/pointer fragments, nested refs, and cycle detection. (0074c72)
  • Full-bleed landing pages. The custom and frame page modes now drop the sidebar and render edge-to-edge; center drops the sidebar too. Default/wide/api pages are unchanged. (969a723)
  • Real home pages. A root index.mdx renders at / (not just a redirect splash), with draft visibility honored and / + /index canonicalized so they don't compete as duplicate content. (738f6b4)
  • Reusable snippet imports + a Link component. import of an /snippets/* Markdown file now resolves against your project root, and Link (with href) is a built-in.
  • Live .jsx/.tsx snippets, and smarter MDX snippets. A React component snippet imported from /snippets/*.jsx renders as an interactive Preact island: hooks work as globals the way Mintlify exposes them, client:visible is auto-attached so it hydrates, and react/react-dom alias to preact/compat. Pages with no JSX snippet ship zero extra client JS. An imported .mdx snippet now inherits the page's component set, so a snippet that uses Note/Card (or imports another snippet) renders correctly. (9cbcfbb, 2e2ed18)
  • Comprehensive Font Awesome icons. About 880 Font Awesome names now resolve to Lucide glyphs (FA 6 renames like magnifying-glass, directional angle-*/caret-* families, and nearest-glyph picks), so icons carried over from Mintlify render unchanged. Names with no Lucide equivalent fall back to a help-circle. (7684d72)

Changes

Features

  • feat(manifest): auto-discover root OpenAPI spec (ce13ae4)
  • feat(manifest): resolve top-level anchors as navigation containers (652d7fb)
  • feat(manifest): resolve docs.json $ref includes (0074c72)
  • feat(manifest): render the default version/language nav variant (b13500c)
  • feat(theme-ui): full-bleed landing layout for custom/frame modes (969a723)
  • feat(theme-ui): add Link component (e62d557)
  • feat(plugin): resolve /snippets/ imports against the project root (8a9d3b7)
  • feat(theme-ui): comprehensive Font Awesome to Lucide icon coverage (7684d72)
  • feat(runtime): render JSX/TSX snippets as preact islands (9cbcfbb)
  • feat(runtime): imported MDX snippets inherit the page component set (2e2ed18)

Fixes

  • fix(runtime): render the root index page at the site root (738f6b4), gate it on draft visibility (fa1eb21), and canonicalize / + /index (5e40d0f)
  • fix(manifest): exclude project meta files from page discovery (da213f8), case-insensitively (1e902e5), plus root public/static/assets (fe2f9b4)
  • fix(manifest): render only one default nav variant (b2d44be) and error on an unresolved $ref pointer (b49fed4)
  • fix(theme-ui): expand Font Awesome to Lucide icon aliases (bdfe738, 00f653e, 866214e, e5f7e22)

Tests

  • test(manifest): cover meta-file exclusion + OpenAPI auto-discovery (4dedaac), anchors-as-nav (504ac69), $ref resolution (af8e8b2), and the draft-home invariant (1c1a588)
  • test(runtime): cover snippet island injection + MDX snippet component threading (9cbcfbb, 2e2ed18)