December 2024

Authentication

Make docs private by setting up authentication via JWT, OAuth, or a universal password. With this privacy, you can create an internal knowledge base or prevent competitors from seeing your docs.

November 2024

AI Assistant

You can now ask AI to make changes to your docs, with the context of all existing documentation. Type in a prompt and the assistant will propose changes by generating a pull request.

GitLab Integration Upgrade

We’ve improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our docs on GitLab to get started.

Web Editor

We’ve revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown.

Check out our docs on getting started with Web Editor.

/llms.txt support

All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the docs on the new llms.txt standard.

Localization

You can now localize your docs which operates similarly to versioning. Add a locale to a version and fixed content in Mintlify like “Was this page helpful?” will also match the locale.

Quality Improvements

  • Return chat & search results based on the current version that the user is reading

  • Authenticate users with OAuth, in addition to JWT or Shared Session tokens.

October 2024

Changelogs

Launched a new Update component to make it easier to display and report updates (like this one) to your users.

Code Line Highlighting

You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces {} and specify line numbers or ranges separated by commas.

Line Highlighting Example
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();
```javascript Line Highlighting Example {1,3-5}
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();
```

Light mode code blocks

Code blocks now have a light mode variant which can be enabled by adding the following to your mint.json:

"codeBlock": {
  "mode": "auto"
}

Advanced Footer

You can now add more links to the standard footer. This upgrade provides more consistency between landing pages and docs, or greater customization if you want to spotlight specific pages like socials or status logs.

Filter search based on the current user

When personalization is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content.

Custom Prompts for AI Chat

You can now customize the prompts for the AI chat. Please reach out to support if you’d like to customize the prompts.

Dashboard Improvements

  • Added ability to change custom domain to be /docs directly through dashboard settings.

  • Consolidated the login and signup pages to decrease friction and confusion.

  • Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.

  • Added login with Google OAuth

  • Added ability to add new deployment through dashboard settings.

Bug Fixes

  • Can now use leading slashes in navigation.

  • Can now edit CSS & JS files in the web editor.

  • Fixed suggestEdit not showing up even when enabled.

  • Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results.

  • Don’t allow search engines to crawl user-auth protected pages.

  • Revalidate the cache when an org is deleted.

  • We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.

  • Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.

  • Add in-line-style support for icons

  • Fixed the pop-in of custom CSS in docs.

  • Properly show in-line code styling in conjunction with links.

  • Maintain scroll position when you click the back button in a browser.

September 2024

Custom Fonts

Personalize the font of your docs to your own font hosted on a CDN or by choosing from Google fonts to match your docs with your brand.

Images in Card components

Add an img property to a card to display an image on the top of the card. Learn more about it here.

Update Speed Performances

For large projects (~3,000 files), the download step for docs updates is now ~440x faster - a 99.8% time reduction. Across the board, file downloads during updates are now ~5.5x faster - an 81.8% time reduction.

SEO improvements

We’ve fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.

Dashboard Improvements

  • App router migration in the dashboard.

  • Search analytics are now available in the dashboard.

  • Delete an org functionality has been added to the dashboard.

  • Shipped GitLab connection UI.

  • Fix incorrect analytics data.

  • Add-on’s can now be directly purchased through the dashboard.

Bug Fixes

  • Fixed a bug where the top bar would not stretch to the width of the screen when it’s in custom mode and the sidebar layout is sidenav.

  • Fix relative positioning of the AI widget.

More

  • Troubleshooting for API pages: API pages could be complicated so we listed common issues to help you sort them out quickly — Read the docs
August 2024

OpenAPI Reference Pages

  • Endpoints defined by OpenAPI that are complex and recursive are now 98% smaller.

  • We now show additionalProperties in OpenAPI pages.

File Uploads in API Playground

By default, API playground requests are proxied by Mintlify. Now you can use disableProxy to disable this behavior and support request types like file uploads.

Mobile SEO improvements

We’ve fixed the mobile layout of our docs so that they are more SEO-friendly - including adding proper aria tags to elements.

Support Form

We added a more detailed support form to the Mintlify dashboard. You can now submit a form to get in touch with us.

Bug Fixes

  • Fixed a bug for the Segment integration functionality.

  • We now raise more granular error messages for GitHub permissions when interacting with the editor.

  • Fixed bugs where the navigation would not properly expand when a direct link was used.

July 2024

AI Widget

For Pro users, we introduced Mintlify Widget, an extension of your docs to answer your users’ questions when and where they asked. You can add this AI-powered chatbot to any web page: your landing page, inside your product, or on your existing documentation pages.

Pro Plan

We also updated our pricing plans for better customizability and scale.

API Playground Code Example Sync

When you browse API docs, the selected code example now syncs across your pages.

Insights

Currently in beta, this feature summarizes common user questions and patterns into easy-to-digest reports with AI-powered suggestions on how to improve your product.

June 2024

Launch Week Highlights

  • Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your mint.json file and it’ll update your docs styling.
  • Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated searchbar UI.
  • Web Editor branching: create branches in our web editor without an IDE.
  • User Personalization: authenticate users with Shared Session or JWT so that you can show them customized content, such as pre-filling API keys or showing specific content for customers.
  • OepenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an openapi field to an object in tabs or anchors arrays in the mint.json.
May 2024

Okta SSO

We now support sign-on via Okta SAML and OIDC.

Mintlify REST API

Programmatically rigger updates to your documentation.

April 2024

Custom mode

Add a configuration to the metadata to remove all elements except for the top bar. Example use cases:

  • Create a custom global landing page setup with custom components
  • Add full-screen videos or image galleries
  • Embed custom iFrame demo elements to add intractability to your docs

Check out our Custom Mode docs.

March 2024

Mintlify MDX for VSCode

Call snippets of our pre-built components an dcallouts without leaving VSCode. Install the extension here.

February 2024

Quality Improvements

  • Dashboard upgrades: view update logs to see what’s changed and status of an update, toggle between Mintlify projects to manage deployments
  • Versioning with tabs fully supported
  • Wildcard redirects now supported
  • CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development
January 2024

Launch Week Highlights

  • Preview Deployments: When you create a pull request, we’ll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.
  • Snippets V2: We now support fully reusable components and variables for snippets.
  • Open-source MDX Engine: We’ve exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. Contributions to the project are welcome.
  • AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.

Was this page helpful?