MDX-Grundlagen
Schreiben Sie Dokumentation in Markdown mit eingebetteten React-Komponenten wie Card, Tabs und Accordion. Dies ist die Syntax hinter jeder Jamdesk-Seite.
Jede Jamdesk-Seite ist eine .mdx-Datei: Standard-Markdown mit JSX-Komponenten wie <Card>, <Tabs> und <Accordion>.
Was ist MDX?
MDX ermöglicht es, Standard-Markdown zu schreiben und JSX-Komponenten in dieselbe Datei einzubetten. Schreiben Sie Überschriften, Listen und Codeblöcke in Markdown und fügen Sie dann Komponenten wie <Card> oder <Tabs> ein, wo Sie Interaktivität benötigen.
MDX ist reiner Text, den KI-Tools nativ lesen und schreiben können. Es ist in Git versionierbar. Es enthält Komponenten ohne ein proprietäres Format.
# 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>Der kostenlose MDX Validator erkennt Syntaxfehler vor einem Build. Der kostenlose MDX Formatter bereinigt Abstände und Einrückungen. Fügen Sie eine Seite ein, um sie ohne Ausführen der CLI zu prüfen oder aufzuräumen.
Seitenstruktur
Jede MDX-Seite beginnt mit Frontmatter, den Metadaten zwischen dreifachen Bindestrichen:
---
title: My Page Title
description: A brief description for search and previews
---
Your content starts here...Der title und die description erscheinen in Suchergebnissen, Browser-Tabs und Vorschauen in sozialen Medien.
Markdown-Grundlagen
Überschriften
Verwenden Sie ## für Hauptabschnitte und ### für Unterabschnitte. Jamdesk erstellt das Inhaltsverzeichnis aus Ihren Überschriften.
## Main Section
Content under the main section.
### Subsection
More detailed content here.Beginnen Sie mit ## (h2) für Ihre erste Überschrift. Der Seitentitel aus dem Frontmatter ist die h1.
Textformatierung
| Syntax | Ergebnis |
|---|---|
**bold** | bold |
*italic* | italic |
~~strikethrough~~ | |
`inline code` | inline code |
Listen
Unordered list:
- First item
- Second item
- Nested item
Ordered list:
1. First step
2. Second step
3. Third stepZitate
> This is a blockquote. Use it for callouts or
> highlighting important information.This is a blockquote. Use it for callouts or highlighting important information.
Komponenten hinzufügen
Komponenten sind JSX-Elemente, die Sie überall in Ihrem MDX verwenden können. Sie sind selbstschließend oder umschließen Inhalte:
{/* 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>Verfügbare Komponenten
Jamdesk stellt diese integrierten Komponenten bereit:
Tabellen
Standard-Markdown-Tabellen funktionieren sofort:
| Feature | Starter | Team |
|---------|------|-----|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes || Feature | Starter | Team |
|---|---|---|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
Verwenden Sie die Table-Komponente für Zeilenhervorhebung, Zellenausrichtung und Zellverbindung:
| Feature | Starter | Team |
|---|---|---|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
Siehe Tabellen für die vollständige Komponentendokumentation, einschließlich Zeilen- und Zellenhervorhebung, Spaltenverbindung und Gestaltungsoptionen.
Kommentare
Fügen Sie Kommentare hinzu, die in der gerenderten Ausgabe nicht erscheinen:
{/* This is a comment - it won't be visible to readers */}