Configuration

The docs-config.json file controls the global settings of your site.

Configuration Structure

Lito’s configuration is divided into two categories:

  • Core Config - Portable across all templates (guaranteed to work)
  • Extensions - Template-specific features (templates ignore what they don’t support)

This means you can swap templates without changing your docs - core config always works, and unsupported extensions are simply ignored.

Core Configuration

These options are supported by ALL Lito templates:

PropertyTypeRequiredDescription
metadataobjectYesSite meta information.
brandingobjectNoLogo, favicon, and primary color.
navigationobjectNoSidebar and navbar structure.
searchobjectNoSearch configuration.
seoobjectNoSEO and social sharing settings.
i18nobjectNoInternationalization settings.
assetsobjectNoAsset folder configuration.

Extensions (Template-Specific)

These options are template-specific. Templates that don’t support them will simply ignore the configuration:

PropertyTypeDescription
footerobjectFooter layout and links.
themeobjectExtended theme options.
landingobjectLanding page configuration.
integrationsobjectAnalytics, feedback, copy page.
versioningobjectDocumentation versioning.

metadata (Required)

"metadata": {
  "name": "Site Name",
  "description": "Site description",
  "url": "https://docs.example.com",
  "version": "1.0.0"
}
PropertyTypeRequiredDescription
namestringYesSite name (appears in title and meta tags).
descriptionstringNoDefault site description for SEO.
urlstringNoBase URL for canonical URLs and OG tags.
versionstringNoDocumentation version.

branding

"branding": {
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "/"
  },
  "favicon": "/favicon.svg",
  "colors": {
    "primary": "#6366f1"
  }
}
PropertyTypeDescription
logo.lightstringLogo for light mode.
logo.darkstringLogo for dark mode.
logo.hrefstringLink when clicking the logo.
faviconstringFavicon path.
colors.primarystringPrimary brand color.
"navigation": {
  "navbar": {
    "links": [
      { "label": "GitHub", "href": "https://github.com/..." }
    ],
    "cta": { "label": "Get Started", "href": "/introduction" }
  },
  "sidebar": [
    {
      "label": "Getting Started",
      "items": [
        { "label": "Installation", "href": "/getting-started/installation" },
        { "label": "Quick Start", "href": "/getting-started/quick-start" }
      ]
    }
  ]
}
PropertyTypeDescription
labelstringDisplay text.
hrefstringPage URL or external link.
slugstringPage slug (alternative to href).
iconstringIconify icon name (e.g., lucide:home).
methodstringHTTP method for API docs (GET, POST, etc.).
itemsarrayNested items for sub-groups.

Locale-Specific Sidebars

You can define different sidebars per locale:

"navigation": {
  "sidebar": [...],
  "sidebar.es": [...],
  "sidebar.fr": [...]
}
"search": {
  "enabled": true,
  "provider": "local",
  "placeholder": "Search docs..."
}
PropertyTypeDefaultDescription
enabledbooleantrueEnable search.
providerstringlocalSearch provider (local or algolia).
placeholderstringSearch...Search input placeholder.

seo

"seo": {
  "ogImage": "/og-image.png",
  "twitterHandle": "@yourhandle",
  "defaultAuthor": "Your Name",
  "defaultKeywords": ["docs", "api"],
  "enableJsonLd": true,
  "organizationName": "Your Org",
  "articleType": "TechArticle",
  "autoCanonical": true,
  "enableBreadcrumbs": true
}
PropertyTypeDefaultDescription
ogImagestring-Default Open Graph image.
twitterHandlestring-Twitter handle for twitter:creator.
twitterSitestring-Twitter site handle.
defaultAuthorstring-Default author name.
defaultKeywordsstring[]-Default keywords for all pages.
enableJsonLdbooleantrueEnable JSON-LD structured data.
organizationNamestring-Organization name for JSON-LD.
organizationLogostring-Organization logo URL.
articleTypestringTechArticleTechArticle or Article.
autoCanonicalbooleantrueAuto-generate canonical URLs.
enableBreadcrumbsbooleantrueEnable breadcrumb JSON-LD.

i18n

"i18n": {
  "defaultLocale": "en",
  "locales": ["en", "es", "fr"],
  "routing": {
    "prefixDefaultLocale": false
  },
  "translations": {
    "es": {
      "search.placeholder": "Buscar..."
    }
  }
}
PropertyTypeDefaultDescription
defaultLocalestringenDefault locale.
localesstring[]["en"]Supported locales.
routing.prefixDefaultLocalebooleanfalseInclude default locale in URLs.
translationsobject-Custom UI translations per locale.

assets

"assets": {
  "images": "_images",
  "css": "_css",
  "static": "_assets"
}
PropertyTypeDefaultDescription
imagesstring_imagesImages folder name.
cssstring_cssCSS folder name.
staticstring_assetsStatic assets folder.

Extensions

landing

Configure an optional landing page:

"landing": {
  "enabled": true,
  "hero": {
    "title": "Your Product",
    "subtitle": "A brief description",
    "version": "v2.0",
    "cta": [
      { "label": "Get Started", "href": "/docs", "variant": "primary" },
      { "label": "GitHub", "href": "https://github.com", "variant": "secondary" }
    ]
  },
  "features": [
    {
      "title": "Feature Name",
      "description": "Feature description",
      "icon": "rocket"
    }
  ]
}
"footer": {
  "layout": "full",
  "tagline": "Beautiful docs made simple",
  "copyright": "© {year} Your Company",
  "showBranding": true,
  "socials": {
    "github": "https://github.com/...",
    "twitter": "https://twitter.com/..."
  },
  "links": [
    {
      "title": "Resources",
      "items": [
        { "label": "Documentation", "href": "/docs" }
      ]
    }
  ]
}

theme

"theme": {
  "mode": "auto",
  "defaultDark": false,
  "primaryColor": "#6366f1",
  "accentColor": "#22d3ee"
}

integrations

"integrations": {
  "analytics": {
    "provider": "google",
    "measurementId": "G-XXXXXXX"
  },
  "feedback": {
    "enabled": true
  },
  "copyPage": {
    "enabled": true,
    "position": "bottom-right"
  }
}

versioning

"versioning": {
  "enabled": true,
  "defaultVersion": "latest",
  "versions": [
    { "id": "latest", "label": "Latest", "path": "latest" },
    { "id": "v1", "label": "v1.0", "path": "v1", "deprecated": true }
  ],
  "versionBanner": {
    "enabled": true,
    "message": "You are viewing docs for an older version."
  }
}