Migrate from Mintlify

@fumapress/mintlify reads your docs.json and configures the navigation, theme, navbar and more from it. It covers docs.json only. Your content source handles the MDX, including Mintlify components like <Card> and <Accordion>.

SetupCopy Anchor Link

npm i @fumapress/mintlify

import { getCollection } from "astro:content";
import { toFumadocsSource } from "@fumadocs/astro/source";
import { createPress } from "@fumapress/astro/config";
import { mintlifyPlugin } from "@fumapress/mintlify";

export default createPress({
  docs: toFumadocsSource(await getCollection("docs"), await getCollection("meta")),
})
  .plugins(mintlifyPlugin());

CustomizationCopy Anchor Link

Feature TogglesCopy Anchor Link

Everything is on by default. Turn off a feature to configure it yourself. This example turns off search:

mintlifyPlugin({
  // relative to the project root
  path: "docs.json",
  // the docs folder inside `content/`
  docsDir: "docs",
  features: {
    navigation: true,
    navbar: true,
    theme: true,
    appearance: true,
    banner: true,
    footer: true,
    redirects: true,
    notFound: true,
    search: false, 
    metadata: true,
  },
});

404 PageCopy Anchor Link

errors.404 creates a page with the type mintlify.404. Restyle it in renderPage:

createPress(content)
  .plugins(mintlifyPlugin())
  .config({
    ui: {
      renderPage(props) {
        if (props.type === "mintlify.404") return <main>{props.title}</main>;
        return props.renderDefault();
      },
    },
  });

LanguagesCopy Anchor Link

When docs.json defines navigation.languages, create the i18n config from it:

import { defineMintlifyI18n, mintlifyPlugin, readMintlifyDocs } from "@fumapress/mintlify";

const mintlifyDocs = readMintlifyDocs();
const i18n = defineMintlifyI18n(mintlifyDocs, {
  // optionally map Mintlify locales to your own codes
  localeMap: { cn: "zh" },
});

export default createPress(content, { i18n })
  .plugins(mintlifyPlugin())
  .config({
    ui: { translations: i18n.translations() },
  });

API PagesCopy Anchor Link

Forward api.openapi sources (file paths or URLs) to the OpenAPI plugin:

import { mintlifyPlugin } from "@fumapress/mintlify";
import { createMintlifyOpenAPI } from "@fumapress/mintlify/openapi";
import openapiPlugin from "fumadocs-openapi/press";

const openapi = createMintlifyOpenAPI();

export default createPress({
  docs: docsSource,
  openapi: await openapi.staticSource(),
}).plugins(mintlifyPlugin(), openapiPlugin({ server: openapi }));

api.asyncapi works the same way, with createMintlifyAsyncAPI from @fumapress/mintlify/asyncapi and the AsyncAPI plugin.

api.playground.proxy turns the proxy on or off. It is on by default, so the site needs a server. Set it to false on a static site.

docs.json SupportCopy Anchor Link

Unsupported properties are accepted and ignored, so they never stop the migration. docs.json can reference other JSON files with $ref, as long as they stay inside your project root.