mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Chonkie",
  "logo": {
    "light": "/logo/chonkie_logo_horizontal_large.png", 
    "dark": "/logo/chonkie_logo_horizontal_large.png", 
    "href": "/"
  },
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#7c6f64",
    "light": "#A86F60",
    "dark": "#504945",
    "background": {
      "dark": "#282828",
      "light": "#faf6e3"
    },
    "anchors": {
      "from": "#7c6f64",
      "to": "#928374"
    }
  },
  "background": {
    "style": "grid"
  },
  "theme": "prism",
  "layout": "topnav",
  "modeToggle": {
    "default": "dark", 
    "isHidden": false
  },
  "topbarCtaButton": {
    "type": "github",
    "url": "https://github.com/bhavnicksm/chonkie"
  },
  "codeBlock":{
     "mode": "auto"
  }, 
  "navigation": [
    {
      "group": "Getting Started",
      "pages": [
        "getting-started/introduction",
        "getting-started/installation", 
        "getting-started/concepts"
      ]
    },
    {
      "group": "Chunkers",
      "pages": [
        "chunkers/overview",
        "chunkers/token-chunker",
        "chunkers/word-chunker",
        "chunkers/sentence-chunker",
        "chunkers/semantic-chunker",
        "chunkers/sdpm-chunker"
      ]
    }, 
    {
      "group": "Embeddings",
      "pages": [
        "embeddings/overview",
        "embeddings/auto-embeddings",
        "embeddings/sentence-transformer-embeddings",
        "embeddings/openai-embeddings",
        "embeddings/model2vec-embeddings",
        "embeddings/custom-embeddings"
      ]
    }
  ],
  "feedback": {
    "thumbsRating": true,
    "suggestEdit": true
  },
  "footerSocials": {
    "github": "https://github.com/bhavnicksm/chonkie",
    "x": "https://x.com/BhavnickMinhas",
    "linkedin": "https://www.linkedin.com/in/bhavnicksm"
  }, 
  "metadata": {
    "og:site_map": "Chonkie Documentation",
    "og:title": "Chonkie Documentation",
    "og:description": "🦛 CHONK your text with Chonkie✨ - A no nonsense text chunking library for RAGs",
    "og:url": "https://docs.chonkie.ai",
    "og:image": "/images/chonkie_logo_white_bg.png",
    "og:logo": "/logo/chonkie_logo_horizontal_large.png",
    "article:publisher": "https://github.saobby.my.eu.orge/bhavnicksm",
    "twitter:title": "Chonkie Documentation",
    "twitter:description": "🦛 CHONK your text with Chonkie✨ - A no nonsense text chunking library for RAGS",
    "twitter:site": "https://docs.chonkie.ai",
    "twitter:image": "/images/chonkie_logo_white_bg.png"
  }
}