Nozioni base di MDX
Scrivi la documentazione in Markdown con componenti React incorporati come Card, Tabs e Accordion. È la sintassi alla base 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 permette di scrivere Markdown standard e inserire componenti JSX nello stesso file. Scrivi intestazioni, elenchi e blocchi di codice in Markdown, poi inserisci componenti come <Card> o <Tabs> dove ti servono per l'interattività.
MDX è testo semplice che gli strumenti di AI possono leggere e scrivere in modo nativo. È gestibile con il controllo di versione in Git. Contiene componenti senza 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>Il Validatore MDX gratuito individua gli errori di sintassi prima di una build. Il Formattatore MDX gratuito sistema spaziatura e indentazione. Incolla una pagina per verificarla o sistemarla senza eseguire la CLI.
Struttura della pagina
Ogni pagina MDX inizia con il frontmatter, i metadati compresi tra tre trattini:
---
title: My Page Title
description: A brief description for search and previews
---
Your content starts here...title e description compaiono nei risultati di ricerca, nelle schede del browser e nelle anteprime sui social media.
Elementi essenziali di Markdown
Titoli
Usa ## per le sezioni principali e ### per le sottosezioni. Jamdesk crea l'indice a partire dalle tue intestazioni.
## Main Section
Content under the main section.
### Subsection
More detailed content here.Inizia con ## (h2) per la prima intestazione. Il titolo della pagina nel frontmatter è l'h1.
Formattazione del testo
| Sintassi | Risultato |
|---|---|
**bold** | grassetto |
*italic* | corsivo |
~~strikethrough~~ | |
`inline code` | codice inline |
Elenchi
Unordered list:
- First item
- Second item
- Nested item
Ordered list:
1. First step
2. Second step
3. Third stepCitazioni
> This is a blockquote. Use it for callouts or
> highlighting important information.This is a blockquote. Use it for callouts or highlighting important information.
Aggiunta di componenti
I componenti sono elementi JSX che puoi usare ovunque nel tuo MDX. Possono essere auto-chiudenti oppure racchiudere 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 subito:
| Feature | Starter | Team |
|---------|------|-----|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes || Feature | Starter | Team |
|---|---|---|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
Usa il componente Table per evidenziare le righe, allineare le celle e unire celle:
| Feature | Starter | Team |
|---|---|---|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
Consulta Tabelle per la documentazione completa del componente, inclusa l'evidenziazione di righe e celle, l'unione di colonne e le opzioni di stile.
Commenti
Aggiungi commenti che non compariranno nell'output renderizzato:
{/* This is a comment - it won't be visible to readers */}