Fern · JSON Structure

Fern Docs Config Structure

JSON Structure for a Fern documentation site configuration.

Type: object Properties: 8 Required: 2

Agent ReadyAIAPI DefinitionsAsyncAPICode GenerationDeveloper ExperienceDeveloper PortalDocumentationgRPCllms.txtMCPOpenAPIOpenRPCPlatformProtobufSDKsWebSockets

FernDocsConfig is a JSON Structure definition published by Fern, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/2025/draft/schema meta-schema.

Properties

title domain logo navigation versions products ai auth

Meta-schema: https://json-structure.org/2025/draft/schema

JSON Structure

{
  "$schema": "https://json-structure.org/2025/draft/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/fern/main/json-structure/fern-docs-config-structure.json",
  "name": "FernDocsConfig",
  "description": "JSON Structure for a Fern documentation site configuration.",
  "type": "object",
  "properties": {
    "title": {"type": "string"},
    "domain": {"type": "string"},
    "logo": {
      "type": "object",
      "properties": {
        "light": {"type": "string"},
        "dark": {"type": "string"},
        "href": {"type": "uri"}
      }
    },
    "navigation": {"type": "array", "items": {"type": "object"}},
    "versions": {"type": "array", "items": {"type": "object"}},
    "products": {"type": "array", "items": {"type": "object"}},
    "ai": {
      "type": "object",
      "properties": {
        "askFernEnabled": {"type": "boolean"},
        "llmsTxtEnabled": {"type": "boolean"},
        "mcp": {
          "type": "object",
          "properties": {
            "enabled": {"type": "boolean"},
            "endpoint": {"type": "uri"}
          }
        }
      }
    },
    "auth": {
      "type": "object",
      "properties": {
        "type": {"type": "string", "enum": ["public", "jwt", "sso", "rbac"]}
      }
    }
  },
  "required": ["title", "navigation"]
}