Jamdesk Documentation logo

Übersicht: Schreiben und Organisieren

Alles zur Erstellung von Jamdesk-Seiten: MDX-Syntax, Codeblöcke, Medieneinbettungen, SEO und Tools zur Vorschau vor der Veröffentlichung.

Jamdesk-Seiten sind MDX-Dateien: standardmäßiges Markdown mit React-Komponenten, die Sie überall dort verwenden können, wo Sie sie benötigen. Eine Seite besteht lediglich aus Frontmatter und Inhalt.

---
title: Rate Limits
description: How rate limiting works across API tiers.
---

Requests are limited per API key.

<Note>Enterprise plans have custom limits.</Note>

Das meiste, was Sie schreiben werden, ist einfaches Markdown. Die Seiten in diesem Abschnitt behandeln den Rest: Codeblöcke mit Syntaxhervorhebung, Bilder und Videos, mathematische Notation, wiederverwendbare Snippets sowie die Frontmatter-Felder, die Titel, Symbole und SEO-Metadaten steuern.

MDX und Seiten

MDX-Grundlagen

Markdown mit eingebetteten React-Komponenten. Beginnen Sie hier.

Codeblöcke

Syntaxhervorhebung, Zeilennummern, Dateinamen und CodeGroups

Benutzerdefinierte React-Komponenten

Definieren Sie eigene Komponenten mit serverseitigem Rendering und Tailwind

Frontmatter

Titel, Beschreibungen, Symbole, Anpassungen der Seitenleiste und SEO-Metadaten

Überschriften

H2- und H3-Überschriften, die das Inhaltsverzeichnis füllen

Symbole

Font Awesome Pro-Symbole in Karten, Hinweisboxen, Navigation und Inline-Text

Links und Anker

Interne Links, Überschriftenanker und externe URLs

Mathematik und LaTeX

KaTeX-Rendering für Gleichungen und Ausdrücke

SEO

Meta-Tags, Social-Media-Vorschauen und automatisch generierte Sitemaps

Verborgene Seiten

Seiten aus Seitenleiste und Suche ausblenden, ohne sie zu löschen

Snippets

Wiederverwendbare Inhaltsblöcke, die Sie seitenübergreifend importieren

Medien und Einbettungen

Bilder

Größenanpassung, Bildunterschriften, Varianten für helles und dunkles Design sowie unterstützte Formate

YouTube

Videos und Shorts mit verzögertem Laden und benutzerdefinierten Startzeiten

Videos

MP4 und WebM mit Autoplay-, Loop- und Poster-Props

iFrames

Vimeo, CodePen, Figma, Loom und andere externe Einbettungen

Tools zur Inhaltserstellung

Sie müssen Ihre Änderungen nicht pushen, um sie zu sehen. Zeigen Sie sie lokal mit der CLI in der Vorschau an, bearbeiten Sie sie im Browser oder steuern Sie den Dev-Server über VS Code.

Lokale Vorschau

Führen Sie Ihre Dokumentation auf Ihrem Rechner mit sofortigem Neuladen aus

Web-Editor

Bearbeiten Sie MDX im Browser mit Live-Vorschau und committen Sie direkt in Ihr Repository

VS-Code-Erweiterung

Starten und stoppen Sie den Dev-Server über die Statusleiste