mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "flatfile.com",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg",
    "href": "https://flatfile.com"
  },
  "isWhiteLabeled": true,
  "api": {
    "baseUrl": "https://platform.flatfile.com/api",
    "auth": {
      "method": "bearer"
    },
    "playground": {
      "mode": "simple"
    }
  },
  "favicon": "/favicon.jpg",
  "colors": {
    "primary": "#3B2FC9",
    "light": "#6673FF",
    "dark": "#3B2FC9",
    "background": {
      "dark": "#0f1117",
      "light": "#fff"
    }
  },
  "feedback": {
    "raiseIssue": true,
    "suggestEdit": true
  },
  "modeToggle": {
    "default": "dark"
  },
  "backgroundImage": "/images/background.png",
  "topbarLinks": [
    {
      "name": "Create account",
      "url": "https://platform.flatfile.com/account/sign-up"
    }
  ],
  "topbarCtaButton": {
    "name": "Sign in",
    "url": "https://platform.flatfile.com"
  },
  "versions": [
    "latest",
    { "name": "v3", "url": "https://flatfile.com/versioned-docs/3.0" },
    { "name": "v2", "url": "https://flatfile.com/versioned-docs/3.0" }
  ],
  "anchors": [
    {
      "name": "Blueprint",
      "icon": "compass-drafting",
      "url": "blueprint"
    },
    {
      "name": "Plugins",
      "icon": "plug",
      "url": "plugins"
    },
    {
      "name": "Developers",
      "icon": "brackets-curly",
      "url": "developer-tools"
    },
    {
      "name": "API Reference",
      "icon": "rectangle-terminal",
      "url": "https://reference.flatfile.com/docs/api/"
    }
  ],
  "navigation": [
    {
      "group": "Documentation",
      "pages": ["overview"]
    },
    {
      "group": "Quickstart",
      "pages": [
        "quickstart/meet-the-workbook",
        "quickstart/add-data-transformation",
        "quickstart/submit-action",
        "quickstart/deploying"
      ]
    },
    {
      "group": "Guides",
      "pages": [
        "guides/handling-data",
        "guides/actions",
        "guides/dynamic-configurations",
        "guides/namespaces",
        "guides/metadata",
        "guides/egress",
        "guides/theming",
        "guides/guest_sidebar",
        "guides/documents",
        "guides/secrets"
      ]
    },
    {
      "group": "Concepts",
      "pages": [
        "concepts/workbooks",
        "concepts/jobs",
        "concepts/events",
        "concepts/spaces"
      ]
    },
    {
      "group": "Use cases",
      "pages": [
        {
          "group": "Embed in your app",
          "icon": "person-to-portal",
          "pages": [
            "use-cases/embedding",
            "use-cases/part2",
            "use-cases/part3",
            "use-cases/part4"
          ]
        },
        "use-cases/headless",
        "use-cases/collaborate"
      ]
    },
    {
      "group": "Blueprint",

      "pages": [
        "blueprint/overview",
        "blueprint/field-types",
        "blueprint/constraints",
        "blueprint/relationships",
        "blueprint/access"
      ]
    },
    {
      "group": "Overview",
      "pages": [
        "developer-tools/environment",
        {
          "group": "Developing with Flatfile",
          "icon": "square-terminal",
          "pages": [
            "developer-tools/developing/running-local",
            "developer-tools/developing/check-for-agents",
            "developer-tools/developing/make-environment"
          ]
        },
        "developer-tools/deploying",
        "developer-tools/client_server_side",
        "developer-tools/flatfile_query_language",
        "developer-tools/versioning"
      ]
    },
    {
      "group": "Security",
      "pages": [
        "developer-tools/security/authentication",
        "developer-tools/security/roles-and-permissions"
      ]
    },
    {
      "group": "Core libraries",
      "pages": [
        "developer-tools/core-libraries/flatfile",
        "developer-tools/core-libraries/api",
        "developer-tools/core-libraries/listener"
      ]
    },
    {
      "group": "Wrappers",
      "icon": "clock",
      "pages": [
        "developer-tools/core-libraries/wrappers/react",
        "developer-tools/core-libraries/wrappers/angular",
        "developer-tools/core-libraries/wrappers/vuejs",
        "developer-tools/core-libraries/wrappers/vanilla"
      ]
    },
    {
      "group": "Plugins",
      "pages": ["plugins/overview"]
    },
    {
      "group": "Extractors",
      "pages": [
        "plugins/extractors/xlsx-extractor",
        "plugins/extractors/json-extractor",
        "plugins/extractors/psv-extractor",
        "plugins/extractors/pdf-extractor",
        {
          "group": "More in development",
          "icon": "clock",
          "pages": [
            "plugins/extractors/doc-extractor",
            "plugins/extractors/zip-extractor"
          ]
        }
      ]
    },
    {
      "group": "Transform",
      "pages": ["plugins/transform/record-hook", "plugins/transform/autocast"]
    },
    {
      "group": "Automation",
      "pages": ["plugins/automations/automap"]
    },
    {
      "group": "Schemas",
      "pages": [
        "plugins/schemas/convert-json-schema",
        {
          "group": "More in development",
          "icon": "clock",
          "pages": [
            "plugins/schemas/convert-openapi",
            "plugins/schemas/convert-graphql",
            "plugins/schemas/convert-sql-ddl"
          ]
        }
      ]
    },
    {
      "group": "Datasets",
      "pages": [
        "plugins/datasets/zipcodes",
        {
          "group": "More in development",
          "icon": "clock",
          "pages": ["plugins/datasets/countries"]
        }
      ]
    },
    {
      "group": "Migrations",
      "pages": ["plugins/migrations/dxp-configure"]
    }
  ],
  "footerSocials": {
    "website": "https://flatfile.com",
    "github": "https://github.com/FlatFilers"
  },
  "analytics": {
    "gtm": {
      "tagId": "GTM-W673X2W"
    }
  },
  "integrations": {
    "intercom": "q8ccrv3f"
  },
  "search": {
    "prompt": "Ask any question (ChatGPT powered)"
  }
}