Marque

La marque contrôle les éléments visuels que les lecteurs voient en premier : logos, favicons et liens de navigation. Tout prend en charge les variantes mode clair/sombre.

Logo

Ajoutez votre logo à l'en-tête de navigation :

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

Dimensions du logo

Les logos s'affichent avec une largeur maximale de 120px. Pour de meilleurs résultats :

• Largeur : 120-240px
• Hauteur : 30-40px
• Format : SVG de préférence

Favicon

Une seule image pour les deux modes :

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

Ou une variante distincte pour chaque mode :

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

Le favicon light s'affiche en mode clair ; dark s'affiche en mode sombre. dark est optionnel. Si omis, light est utilisé dans les deux modes. Jamdesk émet une balise <link rel="icon"> pour le favicon principal, plus un second lien avec media="(prefers-color-scheme: dark)" pour la variante sombre.

Formats pris en charge : SVG, PNG, ICO.

Nom du site

Le champ name apparaît dans les onglets du navigateur et les résultats de recherche :

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

Associez-le à une description pour que les résultats de recherche et les aperçus de liens affichent un vrai contenu plutôt qu'un texte générique par défaut.

Description

Le champ description est le résumé SEO par défaut de votre site. Les moteurs de recherche l'affichent sous le titre de votre site, et les plateformes sociales l'utilisent pour les aperçus de liens :

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

Visez 50 à 160 caractères rédigés pour un lecteur qui décide de cliquer ou non. Les pages qui définissent leur propre frontmatter description l'utilisent à la place ; la description du site couvre tout le reste.

Liens de navigation

Ajoutez des liens à votre barre de navigation :

{
  "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"
    }
  }
}

Options de lien

Bouton principal

Le champ primary crée un bouton d'appel à l'action mis en avant :

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

Pied de page

Ajoutez des liens sociaux et des colonnes de liens personnalisées au pied de page de votre documentation.

Liens sociaux

Affichez des icônes de réseaux sociaux en bas de chaque page :

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

Plateformes prises en charge

Colonnes de liens

Ajoutez des groupes de liens organisés au-dessus de vos icônes 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"
    }
  }
}

Masquer le pied de page sur des pages spécifiques

Utilisez le frontmatter pour masquer le pied de page sur des pages individuelles :

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

Ceci est utile pour les pages d'atterrissage personnalisées ou les pages où le pied de page serait gênant.

Marque Jamdesk

Par défaut, un lien « Powered by Jamdesk » apparaît dans le pied de page de vos pages de documentation. Ce lien aide d'autres équipes à découvrir Jamdesk. Vous pouvez le supprimer si vous le préférez.

Masquer la marque

Pour supprimer la marque Jamdesk :

1. Allez dans Settings dans votre dashboard Jamdesk
2. Trouvez la section Build Settings
3. Désactivez Show Jamdesk Branding
4. Déclenchez un nouveau build

Exemple complet de marque

Voici une configuration de marque complète :

{
  "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" }
        ]
      }
    ]
  }
}

Domaine personnalisé

Ajoutez votre domaine dans le dashboard Jamdesk :

1. Allez dans Settings → Domains
2. Ajoutez votre domaine (par exemple, docs.yourcompany.com)
3. Configurez le DNS comme indiqué
4. Attendez la vérification

Votre documentation sera accessible sur votre domaine personnalisé avec SSL automatique.

Et ensuite ?