Nozioni di base MDX
Scrivi documentazione in Markdown con componenti React incorporati come Card, Tabs e Accordion. Questa è la sintassi di ogni pagina Jamdesk.
Ogni pagina Jamdesk è un file .mdx: Markdown standard con componenti JSX come <Card>, <Tabs> e <Accordion>.
Che cos'è MDX?
MDX ti consente di scrivere Markdown standard e incorporare componenti JSX nello stesso file. Scrivi titoli, elenchi e blocchi di codice in Markdown, quindi inserisci componenti come <Card> o <Tabs> ovunque ti serva interattività.
MDX è inoltre adatto alla documentazione che gli strumenti di IA devono leggere: è testo semplice (quindi possono leggerlo e scriverlo in modo nativo), è versionabile in Git e offre una struttura sufficiente per i componenti senza richiedere un formato proprietario.
# Welcome to My Docs
This is regular **Markdown** with a component below:
<Card title="Quickstart" icon="rocket" href="/quickstart">
Jump right in with our quickstart guide.
</Card>
Due strumenti gratuiti per il browser sono utili durante la scrittura: MDX Validator rileva gli errori di sintassi prima di una build, mentre MDX Formatter sistema spaziatura e rientri. Incolla una pagina per controllarla o riordinarla senza eseguire la CLI.
Struttura della pagina
Ogni pagina MDX inizia con il frontmatter, ovvero i metadati racchiusi tra tre trattini:
---
title: My Page Title
description: A brief description for search and previews
---
Your content starts here...
Il title e la description vengono mostrati nei risultati di ricerca, nelle schede del browser e nelle anteprime dei social media. Scrivili con attenzione.
Elementi essenziali di Markdown
Titoli
Usa ## per le sezioni principali e ### per le sottosezioni. Jamdesk genera automaticamente un indice dai tuoi titoli.
## Main Section
Content under the main section.
### Subsection
More detailed content here.
Inizia con ## (h2) per il primo titolo. Il titolo della pagina nel frontmatter funge da h1.
Formattazione del testo
| Sintassi | Risultato |
|---|---|
**bold** | grassetto |
*italic* | corsivo |
~~strikethrough~~ | |
`inline code` | inline code |
Elenchi
Unordered list:
- First item
- Second item
- Nested item
Ordered list:
1. First step
2. Second step
3. Third step
Citazioni
> This is a blockquote. Use it for callouts or
> highlighting important information.
Questa è una citazione. Usala per callout o per mettere in evidenza informazioni importanti.
Aggiunta di componenti
I componenti sono elementi JSX che puoi usare ovunque nel tuo MDX. Possono essere autochiudenti o racchiudere del contenuto:
{/* Self-closing component */}
<Card title="Example" icon="star" href="/introduction" />
{/* Component wrapping content */}
<Accordion title="Click to expand">
This content is inside the accordion.
</Accordion>
Componenti disponibili
Jamdesk fornisce questi componenti integrati:
Tabelle
Le tabelle Markdown standard funzionano immediatamente:
| Feature | Free | Pro |
|---------|------|-----|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
| Funzionalità | Gratuito | Pro |
|---|---|---|
| Pagine | 10 | Illimitate |
| Dominio personalizzato | No | Sì |
Per funzionalità avanzate come l'evidenziazione delle righe, l'allineamento delle celle e l'unione delle celle, usa il componente Table:
| Funzionalità | Gratuito | Pro |
|---|---|---|
| Pagine | 10 | Illimitate |
| Dominio personalizzato | No | Sì |
Consulta Tabelle per la documentazione completa del componente, inclusi l'evidenziazione di righe e celle, l'unione di colonne e le opzioni di stile.
Commenti
Aggiungi commenti che non verranno visualizzati nell'output renderizzato:
{/* This is a comment - it won't be visible to readers */}
Qual è il prossimo passo?
