Marca

La marca controla los elementos visuales que los lectores ven primero: logos, favicons y enlaces de navegación. Todo admite variantes de modo claro/oscuro.

Logo

Agrega tu logo al encabezado de navegación:

{
  "logo": {
    "light": "/images/logo-light.webp",
    "dark": "/images/logo-dark.webp",
    "href": "https://yourcompany.com"
  }
}

Dimensiones del logo

Los logos se muestran con un ancho máximo de 120px. Para obtener mejores resultados:

• Ancho: 120-240px
• Alto: 30-40px
• Formato: SVG preferido

Favicon

Una imagen para ambos modos:

{
  "favicon": "/images/favicon.svg"
}

O una variante distinta para cada modo:

{
  "favicon": {
    "light": "/images/favicon.svg",
    "dark": "/images/favicon-dark.svg"
  }
}

El favicon light se muestra en modo claro; dark se muestra en modo oscuro. dark es opcional. Cuando se omite, light se usa en ambos modos. Jamdesk genera un <link rel="icon"> para el favicon principal más un segundo enlace con media="(prefers-color-scheme: dark)" para la variante oscura.

Formatos compatibles: SVG, PNG, ICO.

Nombre del sitio

El campo name aparece en las pestañas del navegador y en los resultados de búsqueda:

{
  "name": "Acme Docs",
  "description": "Documentation for the Acme API"
}

Combínalo con una description para que los resultados de búsqueda y las vistas previas de enlaces muestren contenido real en lugar de un texto genérico predeterminado.

Description

El campo description es el resumen SEO predeterminado de tu sitio. Los motores de búsqueda lo muestran debajo del título de tu sitio, y las plataformas sociales lo usan para las vistas previas de enlaces:

{
  "description": "Build, ship, and scale documentation with the Acme platform."
}

Apunta a 50-160 caracteres escritos para un lector que está decidiendo si hacer clic. Las páginas que definen su propio description en el frontmatter usan ese valor en su lugar; la descripción del sitio cubre todo lo demás.

Enlaces de navegación

Agrega enlaces a tu barra de navegación:

{
  "navbar": {
    "links": [
      { "label": "Blog", "href": "https://yourcompany.com/blog" },
      { "label": "Pricing", "href": "https://yourcompany.com/pricing" }
    ],
    "primary": {
      "type": "button",
      "label": "Get Started",
      "href": "https://app.yourcompany.com/signup"
    }
  }
}

Opciones de enlace

Botón primario

El campo primary crea un botón de llamada a la acción destacado:

{
  "primary": {
    "type": "button",
    "label": "Dashboard",
    "href": "https://app.yourcompany.com"
  }
}

Pie de página

Agrega enlaces sociales y columnas de enlaces personalizadas al pie de página de tu documentación.

Enlaces sociales

Muestra iconos de redes sociales en la parte inferior de cada página:

{
  "footer": {
    "socials": {
      "github": "https://github.com/yourcompany",
      "x": "https://x.com/yourcompany",
      "discord": "https://discord.gg/yourserver",
      "linkedin": "https://linkedin.com/company/yourcompany"
    }
  }
}

Plataformas compatibles

Columnas de enlaces

Agrega grupos de enlaces organizados encima de tus iconos sociales:

{
  "footer": {
    "links": [
      {
        "header": "Resources",
        "items": [
          { "label": "Blog", "href": "https://yourcompany.com/blog" },
          { "label": "Changelog", "href": "/changelog" }
        ]
      },
      {
        "header": "Company",
        "items": [
          { "label": "About", "href": "https://yourcompany.com/about" },
          { "label": "Careers", "href": "https://yourcompany.com/careers" }
        ]
      }
    ],
    "socials": {
      "github": "https://github.com/yourcompany",
      "x": "https://x.com/yourcompany"
    }
  }
}

Ocultar el pie de página en páginas específicas

Usa el frontmatter para ocultar el pie de página en páginas individuales:

---
title: Landing Page
hideFooter: true
---

Esto es útil para páginas de destino personalizadas o páginas donde el pie de página resultaría una distracción.

Marca Jamdesk

De forma predeterminada, aparece un enlace "Powered by Jamdesk" en el pie de página de tus páginas de documentación. Este enlace ayuda a que otros equipos descubran Jamdesk. Puedes eliminarlo si lo prefieres.

Ocultar la marca

Para eliminar la marca de Jamdesk:

1. Ve a Settings en tu dashboard de Jamdesk
2. Busca la sección Build Settings
3. Desactiva Show Jamdesk Branding
4. Inicia un nuevo build

Ejemplo completo de marca

Aquí tienes una configuración de marca completa:

{
  "name": "Acme Documentation",
  "description": "Build amazing products with Acme",
  "theme": "jam",
  "colors": {
    "primary": "#6366F1",
    "light": "#818CF8",
    "dark": "#4F46E5"
  },
  "favicon": "/images/favicon.svg",
  "logo": {
    "light": "/images/logo-dark.webp",
    "dark": "/images/logo-light.webp",
    "href": "https://acme.com"
  },
  "navbar": {
    "links": [
      { "label": "API", "href": "/api/overview" },
      { "label": "Blog", "href": "https://acme.com/blog" }
    ],
    "primary": {
      "type": "button",
      "label": "Sign Up",
      "href": "https://app.acme.com/signup"
    }
  },
  "footer": {
    "socials": {
      "github": "https://github.com/acme",
      "x": "https://x.com/acme",
      "discord": "https://discord.gg/acme"
    },
    "links": [
      {
        "header": "Resources",
        "items": [
          { "label": "Blog", "href": "https://acme.com/blog" },
          { "label": "Status", "href": "https://status.acme.com" }
        ]
      }
    ]
  }
}

Dominio personalizado

Agrega tu dominio en el dashboard de Jamdesk:

1. Ve a Settings → Domains
2. Agrega tu dominio (por ejemplo, docs.yourcompany.com)
3. Configura el DNS como se indica
4. Espera la verificación

Tu documentación estará disponible en tu dominio personalizado con SSL automático.

¿Qué sigue?