Jamdesk Documentation logo

Branding

Configura loghi, favicon, link della navbar e contenuto del footer per il tuo sito di documentazione. Supporta varianti per modalità chiara/scura, colori personalizzati e icone per link esterni.

Il branding controlla gli elementi visivi che i lettori vedono per primi: loghi, favicon e link di navigazione. Ognuno accetta varianti per la modalità chiara e scura.

Aggiungi il tuo logo all'intestazione di navigazione:

{
  "logo": {
    "light": "/images/logo-light.webp",
    "dark": "/images/logo-dark.webp",
    "href": "https://yourcompany.com"
  }
}
CampoDescrizione
lightLogo per la modalità chiara (logo scuro su sfondo chiaro)
darkLogo per la modalità scura (logo chiaro su sfondo scuro)
hrefDove porta il clic sul logo

Usa loghi SVG per una resa nitida a qualsiasi dimensione. Usa lo stesso logo per light e dark se ne hai uno solo. Le anteprime dei link non possono mostrare il testo all'interno di un logo SVG. Converti qualsiasi testo in contorni (path). Vedi Personalizza la social card.

I loghi vengono visualizzati con una larghezza massima di 120px. Per risultati ottimali:

  • Larghezza: 120-240px
  • Altezza: 30-40px
  • Formato: SVG preferito

Favicon

Un'unica immagine per entrambe le modalità:

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

Oppure una variante separata per ciascuna modalità:

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

dark è facoltativo. Senza di esso, light viene mostrato in ogni modalità. Jamdesk emette un <link rel="icon"> per la favicon principale più un secondo link con media="(prefers-color-scheme: dark)" per la variante scura.

Formati supportati: SVG, PNG, ICO.

Un SVG che usa currentColor per i tratti e i riempimenti si adatta da solo alla modalità. Il browser sostituisce il colore del primo piano attivo.

Nome del sito

Il campo name appare nelle schede del browser e nei risultati di ricerca:

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

Modifica il formato del titolo, oppure escludi il nome da esso, con seo.titleTemplate.

Abbinalo a una description. Senza di essa, i risultati di ricerca e le anteprime dei link mostrano un testo generico di ripiego.

Descrizione

Il campo description è il riepilogo SEO predefinito del tuo sito. I motori di ricerca lo mostrano sotto il titolo del sito, e le piattaforme social lo usano per le anteprime dei link:

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

Punta a 50-160 caratteri, scritti per un lettore che sta decidendo se cliccare. Le pagine con un proprio frontmatter description usano quello. Tutte le altre pagine usano la descrizione del sito.

Aggiungi link alla navbar:

{
  "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"
    }
  }
}
CampoTipoDescrizione
labelstringTesto visualizzato
hrefstringURL (esterno o interno)

Pulsante principale

Il campo primary crea un pulsante di invito all'azione evidenziato:

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

I link e il pulsante principale si trovano nell'intestazione su tablet e desktop. Sui telefoni non c'è spazio per loro nell'intestazione: compaiono nel menu, con il pulsante principale fissato in basso. Pulsar non mostra i link della navbar né il pulsante principale.

Piè di pagina

Il footer si trova in fondo a ogni pagina. Può contenere icone social, colonne di link e una riga di copyright. Ogni lingua può avere il proprio footer, e puoi modificarne lo stile con CSS personalizzato.

Mostra le icone dei social media in fondo a ogni pagina:

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

Piattaforme supportate

PiattaformaChiaveDescrizione
GitHubgithubLink alla tua organizzazione o repo GitHub
X (Twitter)x o twitterLink al tuo profilo X/Twitter
LinkedInlinkedinLink alla pagina LinkedIn della tua azienda
DiscorddiscordLink al tuo server Discord
SlackslackLink alla tua community Slack
YouTubeyoutubeLink al tuo canale YouTube
InstagraminstagramLink al tuo profilo Instagram
FacebookfacebookLink alla tua pagina Facebook
RedditredditLink al tuo subreddit
TelegramtelegramLink al tuo canale Telegram
BlueskyblueskyLink al tuo profilo Bluesky
ThreadsthreadsLink al tuo profilo Threads
MediummediumLink alla tua pubblicazione Medium
Hacker Newshacker-newsLink al tuo profilo Hacker News
Sito webwebsiteLink al tuo sito web principale

Le icone vengono mostrate in un ordine fisso, qualunque sia l'ordine nella tua configurazione. GitHub e X/Twitter compaiono per primi.

Aggiungi gruppi di link sopra le icone social:

{
  "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"
    }
  }
}
CampoTipoDescrizione
linksarrayArray di oggetti colonna di link
links[].headerstringIntestazione della colonna (facoltativa)
links[].itemsarrayLink nella colonna
links[].items[].labelstringTesto visualizzato per il link
links[].items[].hrefstringURL (percorsi interni o URL esterni)

I link esterni (che iniziano con http) si aprono in una nuova scheda. I link interni navigano all'interno della tua documentazione.

Aggiungi copyright e comparirà sulla riga inferiore del footer, accanto al link "Powered by Jamdesk":

{
  "footer": {
    "copyright": "© 2026 Acme Inc. All rights reserved."
  }
}

È testo semplice. Markdown e HTML vengono mostrati così come scritti, quindi inserisci i link in una colonna di link. Le interruzioni di riga diventano spazi e il limite è di 200 caratteri. Digita direttamente il carattere ©, perché &copy; viene mostrato letteralmente.

In un sito con più lingue, ogni voce di navigation.languages può avere un proprio footer. Accetta gli stessi campi di quello di primo livello:

{
  "footer": {
    "copyright": "© 2026 Acme Inc."
  },
  "navigation": {
    "languages": [
      {
        "language": "en",
        "groups": [...]
      },
      {
        "language": "fr",
        "groups": [...],
        "footer": {
          "links": [
            {
              "header": "Entreprise",
              "items": [{ "label": "À propos", "href": "https://acme.com/fr/about" }]
            }
          ],
          "copyright": "© 2026 Acme Inc. Tous droits réservés."
        }
      }
    ]
  }
}

Il footer di una lingua sostituisce quello di primo livello. Non viene effettuata alcuna unione, quindi copia tutto ciò che vuoi mantenere. Le lingue senza un proprio footer usano quello di primo livello. Vedi Lingue per sapere come nascondere il footer per una singola lingua.

Il footer ha nomi di classe che restano invariati tra una versione e l'altra, quindi il CSS personalizzato che li utilizza continua a funzionare. Ad esempio, questo rende maiuscoli i titoli delle colonne e colora di viola l'icona GitHub:

style.css
.jd-footer-column-title {
  text-transform: uppercase;
  letter-spacing: 0.05em;
}

.jd-footer-social[data-platform="github"] {
  color: #6e40c9;
}

L'elenco completo è in CSS personalizzato.

Nascondere il piè di pagina in pagine specifiche

Usa il frontmatter per nascondere il footer su singole pagine:

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

Usalo su pagine di destinazione personalizzate o ovunque il footer risulti d'intralcio.

Identità visiva di Jamdesk

Per impostazione predefinita, nel footer delle tue pagine di documentazione compare un link "Powered by Jamdesk". Puoi rimuoverlo.

Nascondere l'identità visiva

Per rimuovere il branding Jamdesk:

  1. Vai su Settings nella tua dashboard Jamdesk
  2. Trova la sezione Build Settings
  3. Disattiva Show Jamdesk Branding
  4. Avvia una nuova build

L'opzione per il branding è disponibile in tutti i piani. Le modifiche hanno effetto dopo una nuova build.

Esempio completo di identità visiva

Una configurazione completa del branding:

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

Aggiungi il tuo dominio nella dashboard Jamdesk:

  1. Vai su Settings → Domains
  2. Aggiungi il tuo dominio (ad esempio docs.yourcompany.com)
  3. Configura il DNS come indicato
  4. Attendi la verifica

La tua documentazione verrà poi caricata sul tuo dominio personalizzato, con SSL automatico.

Cosa fare ora?

Theming

Personalizza colori e tipografia

SEO Optimization

Migliora i metadati di ricerca e le anteprime