mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Chainlit",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg",
    "href": "https://github.com/Chainlit/chainlit"
  },
  "modeToggle": {
    "default": "dark",
    "isHidden": true
  },
  "favicon": "/favicon.svg",
  "colors": {
    "primary": "#F80061",
    "light": "#FFE7EB",
    "dark": "#980039",
    "background": {
      "dark": "#111010"
    }
  },
  "topbarCtaButton": {
    "name": "Join Discord",
    "url": "https://discord.gg/k73SQ3FyUh"
  },
  "feedback": {
    "thumbsRating": true,
    "suggestEdit": true,
    "raiseIssue": true
  },
  "tabs": [
    {
      "name": "Examples",
      "url": "examples"
    },
    {
      "name": "API Reference",
      "url": "api-reference"
    }
  ],
  "topbarLinks": [
    {
      "name": "Github",
      "url": "https://github.com/Chainlit/chainlit"
    }
  ],
  "navigation": [
    {
      "group": "Get Started",
      "pages": [
        "get-started/overview",
        "get-started/installation",
        "get-started/pure-python",
        {
          "group": "Integrations",
          "pages": [
            "integrations/openai",
            "integrations/langchain",
            "integrations/llama-index",
            "integrations/haystack",
            "integrations/embedchain"
          ]
        }
      ]
    },
    {
      "group": "Basic Concepts",
      "pages": [
        "concepts/chat-lifecycle",
        "concepts/message",
        "concepts/step",
        "concepts/user-session",
        "concepts/element",
        "concepts/action"
      ]
    },
    {
      "group": "Advanced Features",
      "pages": [
        "advanced-features/streaming",
        "advanced-features/ask-user",
        "advanced-features/multi-modal",
        "advanced-features/chat-profiles",
        "advanced-features/chat-settings",
        {
          "group": "Prompt Playground",
          "pages": [
            "advanced-features/prompt-playground/overview",
            "advanced-features/prompt-playground/setup",
            "advanced-features/prompt-playground/formatted-prompts",
            "advanced-features/prompt-playground/llm-providers"
          ]
        }
      ]
    },
    {
      "group": "Deployment",
      "pages": ["deployment/tutorials", "deployment/copilot"]
    },
    {
      "group": "Data Persistence",
      "pages": [
        "data-persistence/overview",
        "data-persistence/history",
        "data-persistence/feedback",
        "data-persistence/enterprise",
        "data-persistence/custom"
      ]
    },
    {
      "group": "Authentication",
      "pages": [
        "authentication/overview",
        "authentication/password",
        "authentication/header",
        "authentication/oauth"
      ]
    },
    {
      "group": "Customisation",
      "pages": [
        "customisation/overview",
        "customisation/translation",
        "customisation/custom-logo-and-favicon",
        "customisation/theme",
        "customisation/custom-js",
        "customisation/custom-css",
        "customisation/custom-font",
        "customisation/react-frontend"
      ]
    },
    {
      "group": "Backend",
      "pages": [
        {
          "group": "Config",
          "pages": [
            "backend/config/overview",
            "backend/config/features",
            "backend/config/ui"
          ]
        },
        "backend/env-variables",
        "backend/custom-endpoint",
        "backend/command-line"
      ]
    },
    {
      "group": "Guides",
      "pages": [
        "guides/sync-async",
        "guides/migration/1.0.0",
        "guides/migration/1.0.300"
      ]
    },
    {
      "group": "Examples",
      "pages": [
        "examples/cookbook",
        "examples/openai-sql",
        "examples/mrkl",
        "examples/qa",
        "examples/security",
        "examples/community"
      ]
    },
    {
      "group": "Life Cycle Hooks",
      "pages": [
        "api-reference/lifecycle-hooks/on-chat-start",
        "api-reference/lifecycle-hooks/on-chat-end",
        "api-reference/lifecycle-hooks/on-chat-resume",
        "api-reference/lifecycle-hooks/on-message",
        "api-reference/lifecycle-hooks/on-logout"
      ]
    },
    {
      "group": "Chat",
      "pages": [
        "api-reference/message",
        "api-reference/step-decorator",
        "api-reference/step-class",
        "api-reference/action",
        "api-reference/chat-profiles",
        "api-reference/chat-settings"
      ]
    },
    {
      "group": "Elements",
      "pages": [
        "api-reference/elements/text",
        "api-reference/elements/image",
        "api-reference/elements/file",
        "api-reference/elements/pdf",
        "api-reference/elements/audio",
        "api-reference/elements/video",
        "api-reference/elements/avatar",
        "api-reference/elements/plotly",
        "api-reference/elements/pyplot",
        "api-reference/elements/tasklist"
      ]
    },
    {
      "group": "Ask User",
      "pages": [
        "api-reference/ask/ask-for-input",
        "api-reference/ask/ask-for-file",
        "api-reference/ask/ask-for-action"
      ]
    },
    {
      "group": "Integrations",
      "pages": [
        "api-reference/integrations/langchain",
        "api-reference/integrations/llamaindex",
        "api-reference/integrations/haystack"
      ]
    },
    {
      "group": "Generation",
      "pages": [
        "api-reference/generation/chat-generation",
        "api-reference/generation/generation-message",
        "api-reference/generation/completion-generation"
      ]
    },

    {
      "group": "Misceallaneous",
      "pages": [
        "api-reference/author-rename",
        "api-reference/make-async",
        "api-reference/cache"
      ]
    },

    {
      "group": "Input Widgets",
      "pages": [
        "api-reference/input-widgets/select",
        "api-reference/input-widgets/slider",
        "api-reference/input-widgets/switch",
        "api-reference/input-widgets/tags",
        "api-reference/input-widgets/textinput"
      ]
    }
  ],
  "footerSocials": {
    "github": "https://github.com/Chainlit/chainlit",
    "discord": "https://discord.gg/k73SQ3FyUh",
    "twitter": "https://twitter.com/chainlit_io",
    "linkedin": "https://www.linkedin.com/company/chainlit"
  }
}