What's new in Jamdesk, the docs-as-code platform for MDX, GitHub, and API documentation. Feature releases, CLI updates, and platform changes.
New features, platform changes, and CLI updates for Jamdesk.
Embed your changelog anywhere. A "What's new?" launcher drops into your own app with one <script> tag and opens your Jamdesk changelog in a modal, with a per-visitor unread dot. Generate the snippet from Settings → What's New widget, then tune the launcher mode, corner, modal size, and dot color with data- attributes. Your changelog stays in your docs; the widget brings it into your product. Embed Your Changelog →
Download your API specs as a zip. On any API reference page, the AI Actions menu now has a Download API spec option that bundles every OpenAPI spec your site references — local files and remote URLs alike — into a single api-specs.zip. Multi-file specs keep their $ref folder structure, so the download drops straight into Postman, a client generator, or your own tooling. AI Actions →
OpenAPI specs validated at build time. Every deploy now strictly validates the OpenAPI specs your docs.json references — and surfaces any problem as a non-fatal build warning instead of failing the build. Your docs still publish; you just get told exactly what's wrong (a YAML parse error with line and column, an unresolved $ref, or a duplicate operationId) by email and in the dashboard's build list. Locally, jamdesk dev still stops on an invalid spec so you catch it before pushing. CLI overview →
Ask AI straight from search. Start typing in search, then hand your question to the AI chat instead of opening a result — press ⌘/Ctrl+Enter or click Ask AI in the search footer. The question is appended to your chat conversation so you can keep a thread going, and plain Enter still jumps to the top result. AI Chat →
Copy answers and transcripts. Every AI chat answer has a copy button that grabs the Markdown source, and a Copy transcript action in the chat header copies the whole conversation as role-labeled Markdown — handy for pasting into an issue or a doc. AI Chat →
Smarter chat auto-scroll. The chat only follows a streaming answer when you're already at the bottom. Scroll up to re-read an earlier reply and it stays put instead of yanking you down; scroll back to the bottom and it re-pins.
Custom CSS in local preview (CLI). jamdesk dev applies your custom CSS the same way the published build does, so you can check styling before deploying. Drop any .css file in your project root — style.css, or several combined alphabetically — and it loads on browser refresh. No docs.json entry needed, matching how Mintlify includes root stylesheets. Custom CSS →
Custom social previews from frontmatter. Set any Open Graph or Twitter/X meta tag directly in a page's frontmatter — og:title, og:description, og:image, twitter:card, keywords, and the full metatag set. Use flat top-level keys or a nested seo: block; both work, and per-page values override your docs.json defaults. SEO →
Hidden pages. Keep drafts, internal handbooks, or deprecated guides out of your sidebar and search results without deleting them. Add hidden: true to a page's frontmatter, or to a group or tab in docs.json. Hidden pages stay reachable by direct URL but disappear from navigation, sitemap, on-site search, and AI context — and pick up an automatic noindex tag. Need a hidden group whose pages still rank in search? Add searchable: true alongside hidden. Hidden pages →
Grid and windows decorations. Two new background patterns join the Jam theme's gradient default. Set background.decoration to "grid" for a subtle 24px dot grid, or "windows" for two Windows 11–style frosted spots in the upper corners. The gradient and "none" flat fill still work as before — pick the look that fits your brand. Background →
Background customization. A new background block in docs.json disables the Jam light-mode gradient, overrides the page color per mode, or tunes the gradient's color, size, position, and opacity. No custom CSS needed. Background →
D2 Diagrams. A second diagram language joins Mermaid. Tag a fenced code block d2 and Jamdesk renders it as a build-time SVG, with light and dark themes baked in. Same workflow as Mermaid — pick whichever language fits the diagram you're drawing. D2 Diagrams →
Grouped search results. Search no longer repeats the same page for every section match. Hits bucket under their parent page in the search modal, with up to three sections visible by default and an inline expander for the rest. Snippet highlighting stays put — you find the right section in fewer scans.
Auto-detect docs.json on connect. Connecting a GitHub repo finds your docs.json wherever it lives. The connect flow scans the whole tree and flags a Mintlify mint.json if it stumbles on one instead. Monorepos and nested configs work with no manual setup. Connecting GitHub →
docs.json location hints in the CLI. Misplaced configs are easier to spot. jamdesk validate, jamdesk dev, and jamdesk doctor report where your docs.json actually is — or where it should go — instead of a generic "not found" error. Fix it in seconds instead of decoding a stack trace. CLI overview →
Standards-compliant hreflang. Hreflang tags now emit valid BCP 47 codes. Locale folders like cn, jp, and ja-jp map to the codes search engines actually expect (zh, ja), with sitemap URLs XML-escaped. Every localized page ranks in its own region instead of being treated as duplicate content. Languages →
PDF Export. Render your whole docs site to a single PDF from Settings → PDF Exports in the dashboard. Paid plans only. Multi-language projects pick a locale per export, results are cached per commit, and you get an email with a download link when rendering finishes.
Multi-language OpenAPI Specs. Endpoint pages render translated OpenAPI specs alongside translated MDX. Drop a <spec>.<lang>.<ext> file (e.g., openapi/api.fr.yaml) next to your source spec and Jamdesk picks it up on that language's URLs, falling back to the English spec when a language variant is missing. Operation summaries, parameter descriptions, response descriptions, and schema descriptions all localize. Setup: Translating OpenAPI Specs.
Visibility Component. New <Visibility for="humans|agents"> component lets you carve out content for human readers or AI agents on the same page. Human-only blocks render in the browser but are stripped from .md exports and llms-full.txt; agent-only blocks do the reverse. Agents requesting Accept: text/markdown on canonical URLs automatically get the agent view.
Password Protection, rebuilt. Lock your whole site behind a shared password, or gate just a handful of pages while the rest stay public. Set auth.password.enabled: true for whole-site mode, or mark individual pages with private: true in frontmatter (or list them under auth.password.private) for specific-pages mode. The Settings page in the dashboard walks you through setting, rotating, and revoking the password. Visitors hit a branded unlock screen with your site's logo, primary color, and an optional hint you define in docs.json. Setup guide: Password Protection.
Automatic WebP Image Conversion. Jamdesk can convert your PNG and JPG images to WebP at build time. Converted files are usually 60-80% smaller than the originals with no visible quality loss, so your pages load faster without any manual image processing. Opt in via images.convertToWebp: true in docs.json. Favicons, og:image, and twitter:image stay in their original format for social crawler compatibility. A new Optimizing images step shows live progress in the dashboard and CLI during each build. Automatic Image Conversion →
API Playground. Endpoint pages now have an interactive "Try it" button. Fill in parameters, watch code examples update in real time, and send live requests without leaving your docs. Enabled by default on all API pages. Works with both OpenAPI and MDX-authored endpoints.
Claude Code Plugin. Install the Jamdesk plugin for Claude Code to give Claude deep knowledge of MDX components, docs.json configuration, navigation patterns, and CLI commands. Two-step install from the plugin marketplace. Pairs with CLAUDE.md and the MCP server for AI-assisted doc writing.
Build Warnings for Missing Branding. Builds now warn when favicon or logo paths in docs.json reference files that don't exist in your project. Warnings appear in the dashboard build details and in the CLI via jamdesk dev and jamdesk validate. No email; the warning is informational only.
YouTube Shorts. The <YouTube> component supports vertical Shorts via the short prop, rendering a centered 9:16 player with no black bars. Use <YouTube id="VIDEO_ID" short />.
AI Actions Menu. A dropdown on every page lets readers copy Markdown, open the page in ChatGPT/Claude/Perplexity, grab the MCP server config, or one-click install it in Cursor or VS Code. Enabled by default; pick which options show up via contextual in docs.json.
Analytics. Cookie-free page analytics tracking views, traffic sources, and visitor trends with per-page breakdowns. No consent banner needed. Overview: Analytics.
Integrations. Google Analytics 4, Google Tag Manager, Plausible Analytics, and Slack build notifications (Pro).
RSS Feed for Changelogs. Pages with rss: true in frontmatter now auto-generate a subscribable RSS feed. An RSS icon appears next to the page title, and a feed.xml is built from your Update components during each build. Use the new date prop on Update for proper feed dates.
CLI Login & Deploy. jamdesk login authenticates via browser. jamdesk deploy packages your project and triggers a build from the terminal. No GitHub connection required. The CLI respects .gitignore, warns about secret files, and streams build progress inline.
CLI Spellcheck. jamdesk spellcheck checks your documentation for spelling errors with 180+ built-in tech terms (English only). jamdesk spellcheck --fix launches an interactive mode to fix typos or add words to your ignore list.
Video Embeds. Embed .mp4 and .webm files directly in your docs. Drop them in a /videos directory and use markdown syntax (<Video src="/_jd/videos/demo.mp4?v=mpzun54z" title="Demo" />) or the <Video> component for autoplay, looping, and other controls.
Custom JavaScript. Add client-side scripts for chat widgets, analytics, or third-party integrations via styling.js in docs.json.
AI Chat. Built-in chat assistant on every docs site. Visitors ask questions and get answers with citation links back to source pages. Powered by Claude, enabled on all plans.
AI Integration. Every site generates llms.txt for LLM context windows, exposes raw Markdown at .md URLs, and includes an MCP server at /_mcp with searchDocs and getPage tools. Setup guides for Claude Code, Cursor, and Codex. Also: Writing with AI and Automated Updates.
CLI. jamdesk dev for local preview with hot reload, jamdesk validate for broken links, jamdesk migrate to convert from Mintlify/GitBook/Docusaurus, jamdesk doctor for setup issues. Install via npm, curl, or Homebrew. Full reference →
VS Code Extension. Start, stop, and restart the dev server from the VS Code status bar, no terminal required.
Custom Domain TXT Verification. All custom domains now require a TXT record (_jamdesk.yourdomain.com) before routing activates. This prevents domain takeover on unclaimed subdomains. Newly added domains will see the TXT record in the dashboard setup flow. See the Custom Domains guide.
Multi-Language Support. Define separate navigation trees and content directories per locale. Readers switch languages from a dropdown in the top bar.
Search Analytics. What readers search for, which queries return nothing, and which results actually get clicked. Useful for finding content gaps.
Jamdesk launches. Write docs in MDX, push to GitHub, get a site on a global CDN. Builds finish in under 60 seconds.
MDX & Components. 20+ built-in components: tabs, accordions, steps, code groups, Mermaid diagrams, KaTeX math, and icons. Syntax highlighting with line numbers in code blocks. Build custom React components with Tailwind and hooks, and reuse content with snippets. Components Overview →
OpenAPI Documentation. Generate API reference pages from your OpenAPI spec via api.openapi in docs.json.
Deployment. Auto-deploy from GitHub on push with 10s debounce. Custom domains with automatic SSL, subpath hosting at /docs (Vercel, CloudFront, Cloudflare, nginx), and monorepo support.
Customization. Three themes (jam, nebula, pulsar) with custom colors, logos, and footer. Custom CSS for style overrides. Flexible navigation with tabs, groups, and icons. Redirects with exact and wildcard matching.
Search & SEO. Cmd+K full-text search, zero config. Sitemaps, OG images, and per-page meta out of the box.
docs.json Reference. Complete configuration reference for all settings and options.
Help Center. Account management, billing, and troubleshooting guides.
