Skip to content
shipyard
  • Docusaurus Feature-Parität Roadmap
On this page

Docusaurus Feature-Parität Roadmap

Dieses Dokument verfolgt shipyards Fortschritt bei der Unterstützung von Features aus Docusaurus’ drei Haupt-Content-Plugins. Features sind markiert als:

  • ✅ Unterstützt - Bereits in shipyard implementiert
  • 🔄 Teilweise - Teilweise implementiert oder über Astro verfügbar
  • ⏳ Geplant - Auf der Roadmap für zukünftige Implementierung
  • ❌ Nicht anwendbar - Nicht relevant für shipyard (meist weil Astro es nativ handhabt)

Dokumentations-Plugin (@docusaurus/plugin-content-docs)

Kern-Funktionalität

  • Dokumentationsseiten aus Markdown/MDX rendern
  • Dokumentationsrouten automatisch generieren
  • Dokumentations-Sidebar-Navigation
  • Mehrere Dokumentations-Instanzen (Multi-Instance Docs)
  • Dokumentationsversionierung

Konfigurationsoptionen

  • Benutzerdefinierter Pfad zum Docs-Inhaltsverzeichnis
  • Benutzerdefinierter URL-Basispfad (routeBasePath)
  • Sidebar-Konfigurationspfad
  • Einklappbare Sidebar-Kategorien (sidebarCollapsible)
  • Sidebar-Kategorien starten eingeklappt (sidebarCollapsed)
  • “Diese Seite bearbeiten”-Links (editUrl)
  • Letzten Aktualisierungszeitpunkt anzeigen (showLastUpdateTime)
  • Letzten Aktualisierungsautor anzeigen (showLastUpdateAuthor)
  • Breadcrumb-Navigation (breadcrumbs)
  • Include/Exclude Glob-Muster
  • Benutzerdefinierte Doc-Layout-Komponente (teilweise - verwendet Astro-Layouts)
  • Benutzerdefinierte Doc-Item-Komponente (teilweise - verwendet Astro-Layouts)
  • Remark-Plugins-Unterstützung (via Astro)
  • Rehype-Plugins-Unterstützung (via Astro)

Frontmatter-Unterstützung

  • title - Dokumenttitel (verwendet in Sidebar, noch nicht im <title> Tag)
  • description - Meta-Beschreibung für SEO (Schema existiert, noch nicht in Docs gerendert)
  • slug - Benutzerdefinierter URL-Slug (Routen werden aus Dateipfaden generiert)
  • sidebar.label - Benutzerdefiniertes Sidebar-Label
  • sidebar.position - Position in Sidebar
  • sidebar.className - Benutzerdefinierte CSS-Klasse für Sidebar-Eintrag
  • sidebar.customProps - Benutzerdefinierte Eigenschaften für Sidebar-Eintrag
  • id - Dokument-ID zum Referenzieren
  • hide_title - Titelüberschrift verstecken
  • hide_table_of_contents - TOC-Sidebar verstecken
  • toc_min_heading_level - Minimale Überschriftenebene für TOC
  • toc_max_heading_level - Maximale Überschriftenebene für TOC
  • pagination_next - Benutzerdefinierte nächste Seite
  • pagination_prev - Benutzerdefinierte vorherige Seite
  • pagination_label - Benutzerdefiniertes Paginierungs-Label
  • keywords - Keywords für SEO
  • image - Social-Media-Vorschaubild
  • tags - Dokument-Tags
  • draft - Als Entwurf markieren (aus Produktion ausgeschlossen)
  • last_update - Manuelle letzte Aktualisierungsinfo
  • unlisted - Aus Produktion verstecken aber zugänglich halten

MDX & Markdown-Features

  • Standard-Markdown-Unterstützung
  • MDX-Unterstützung (via Astro MDX Integration)
  • React/Astro-Komponenten in MDX importieren
  • Admonitions/Callouts (:::note, :::tip, :::warning, etc.)
  • Code-Blöcke mit Syntax-Highlighting (via Astro/Shiki)
  • Zeilen-Highlighting in Code-Blöcken
  • Zeilennummerierung in Code-Blöcken
  • Code-Block-Titel/Dateinamen
  • Live-Code-Editoren
  • npm2yarn Code-Block-Unterstützung (via remarkNpm2Yarn Plugin)
  • Automatische Überschriften-Anker
  • Tabs-Komponente
  • Details/Einklappbare Abschnitte-Komponente
  • doc Typ - Link zu einem bestimmten Dokument
  • category Typ - Einklappbare Kategorie mit verschachtelten Einträgen
  • link Typ - Externer oder interner Link in Sidebar
  • html Typ - Benutzerdefinierter HTML-Inhalt in Sidebar (via labelHtml und defaultStyle)
  • autogenerated - Sidebar automatisch aus Dateistruktur generieren
  • ref Typ - Referenz zu einem anderen Sidebar-Eintrag
  • Kategorie-Indexseiten (Ordner mit index.md)
  • Kategorie-Metadaten via index.md Frontmatter (sidebar.label, sidebar.position, collapsed, collapsible, sidebar.className, sidebar.customProps)
  • Benutzerdefinierte Kategorie-Icons (via sidebar.customProps im index.md Frontmatter)
  • Mehrere Sidebars (via Navigations-Config)
  • Sidebar pro Seite verstecken (hide_sidebar)
  • Aktive Seite hervorheben

Versionierung

  • Versionierte Dokumentations-Snapshots erstellen
  • Versions-Dropdown-Auswahl
  • Versions-Badges
  • Nicht-gewartete Versions-Banner
  • Benutzerdefinierte Versions-Labels
  • Versionsspezifische Sidebars
  • Versionsspezifische Edit-URLs

SEO-Features

  • Meta-Beschreibung aus Frontmatter
  • OpenGraph-Tags (og:title, og:description)
  • Benutzerdefinierte kanonische URLs
  • Keywords-Unterstützung
  • Benutzerdefinierte Meta-Tags via Frontmatter
  • Social-Card-Bilder (og:image, twitter:image)
  • Sitemap-Generierung (via Astro Sitemap Integration)

Blog-Plugin (@docusaurus/plugin-content-blog)

Kern-Funktionalität

  • Blog-Beitragsverwaltung aus Markdown/MDX-Dateien
  • Blog-Listenansicht mit Beiträgen
  • Individuelle Blog-Beitragsseiten
  • Autorenverwaltung
  • Tag-System für Blog-Beiträge
  • RSS/Atom-Feed-Generierung
  • Archivseite

Konfigurationsoptionen

  • Benutzerdefinierter Pfad zum Blog-Inhaltsverzeichnis
  • Benutzerdefinierter URL-Basispfad
  • Blog-Titel-Konfiguration
  • Blog-Beschreibungs-Konfiguration
  • Blog-Sidebar-Titel
  • Blog-Sidebar-Beitragsanzahl
  • Beiträge pro Seite (Paginierung)
  • Benutzerdefinierte Blog-Listen-Komponente (teilweise - verwendet Astro)
  • Benutzerdefinierte Blog-Beitrags-Komponente (teilweise - verwendet Astro)
  • Authors-Map-Datei-Unterstützung
  • Lesezeit anzeigen
  • Benutzerdefinierte Lesezeit-Berechnung
  • “Diese Seite bearbeiten”-Links
  • Kürzungsmarker (<!--truncate-->)
  • RSS/Atom-Feed-Optionen
  • Beiträge nach Datum sortieren
  • Remark-Plugins (via Astro)
  • Rehype-Plugins (via Astro)

Frontmatter-Unterstützung

  • title - Beitragstitel
  • description - Beitragsbeschreibung/Auszug
  • date - Veröffentlichungsdatum
  • authors - Beitragsautor(en)
  • tags - Beitrags-Tags
  • image - Social-Card-Bild
  • keywords - SEO-Keywords
  • hide_table_of_contents - TOC verstecken
  • toc_min_heading_level - Min TOC-Level
  • toc_max_heading_level - Max TOC-Level
  • draft - Als Entwurf markieren
  • unlisted - Ungelisteter Beitrag
  • last_update - Letzte Aktualisierungsinfo
  • slug - Benutzerdefinierter URL-Slug

Autoren-Features

  • Autorenname
  • Autorenrolle/Titel
  • Autoren-URL/Website
  • Autoren-Avatar-Bild
  • Autoren-E-Mail
  • Generierte Autorenseiten
  • Mehrere Autoren pro Beitrag
  • Inline-Autorendefinition im Frontmatter

Tag-Features

  • Tag-Listenansicht
  • Individuelle Tag-Seiten
  • Tag-Anzahlen
  • Tags-Definitionsdatei
  • Tag-Beschreibungen
  • Tag-Permalinks

Feed-Features

  • RSS 2.0 Feed
  • Atom Feed
  • JSON Feed
  • Benutzerdefinierte Feed-Konfiguration
  • Feed-Titel/Beschreibung
  • Feed-Eintrags-Limits
  • Blog-Sidebar mit Beiträgen
  • Paginierungssteuerung
  • Vorheriger/Nächster Beitrags-Navigation
  • Archivseite mit chronologischer Auflistung
  • Tag-basierte Navigation

Andere Blog-Features

  • Lesezeit-Schätzung
  • Multi-Instance Blogs (via routeBasePath Konfiguration)
  • i18n-Unterstützung für Blog-Beiträge
  • Entwurfs-Beiträge (nur Dev)

Seiten-Plugin (@docusaurus/plugin-content-pages)

Kern-Funktionalität

  • Eigenständige Seiten erstellen (via Astro Pages)
  • Unterstützung für Astro/React und Markdown/MDX-Seiten
  • Routengenerierung aus Dateistruktur
  • Landing Pages und benutzerdefinierte Seiten

Konfigurationsoptionen

  • Benutzerdefinierter Pfad zum Seitenverzeichnis (Astro nativ)
  • Basis-URL-Route (Astro nativ)
  • Include/Exclude-Muster (Astro nativ)
  • Remark-Plugins (via Astro)
  • Rehype-Plugins (via Astro)

Seitentypen

Komponenten-Seiten (Astro/React)

  • Vollständige Komponentenseiten (.astro, .tsx)
  • Zugriff auf shipyard-Komponenten und Layouts
  • Benutzerdefinierte Layouts
  • Dynamischer Inhalt
  • Client-seitige Interaktivität (via Astro)

Markdown/MDX-Seiten

  • Markdown-Seiten mit Frontmatter
  • MDX-Unterstützung (via Astro)
  • Komponenten in MDX importieren
  • shipyard-Komponenten verwenden

Frontmatter-Unterstützung (MDX-Seiten)

  • title - Seitentitel
  • description - Meta-Beschreibung
  • keywords - SEO-Keywords
  • image - Social-Vorschaubild
  • wrapperClassName - Benutzerdefinierte Wrapper-Klasse
  • canonical_url - Benutzerdefinierte kanonische URL
  • custom_meta_tags - Benutzerdefinierte Meta-Tags
  • hide_table_of_contents - TOC verstecken
  • draft - Als Entwurf markieren
  • unlisted - Ungelistete Seite

Routing-Features

  • Dateibasiertes Routing (Astro nativ)
  • Verschachtelte Routen via Ordnerstruktur
  • Indexseiten
  • Dynamische Routen (Astro nativ)

Plugin-übergreifende Features

Gemeinsame Fähigkeiten

  • MDX-Unterstützung mit Komponenten (via Astro)
  • Remark/Rehype-Plugin-Erweiterbarkeit (via Astro)
  • Admonitions/Callouts in allen Inhaltstypen
  • Entwurfsmodus für alle Inhaltstypen
  • Ungelisteter Inhalt für alle Typen
  • i18n/Internationalisierungs-Unterstützung
  • Asset-Handling (Bilder, Dateien)
  • Theme-Komponenten (via Tailwind/DaisyUI)
  • SEO-Meta-Tags

Navigation & UI

  • Globale Navigationsleiste
  • Mobile-responsives Hamburger-Menü
  • Sidebar-Navigation (Docs)
  • Breadcrumbs
  • Inhaltsverzeichnis
  • Such-Integration
  • Ankündigungsbanner
  • Theme/Dark-Mode-Toggle

Theming & Styling

  • Tailwind CSS-Integration
  • DaisyUI-Komponentenbibliothek
  • Typography (Prose)-Styling
  • Responsives Design
  • Benutzerdefinierte CSS-Klassen via Frontmatter
  • Theme-Konfigurationsdatei
  • Komponenten-Swizzling/Overrides

Features nicht anwendbar für shipyard

Die folgenden Docusaurus-Features sind nicht anwendbar weil Astro sie nativ handhabt oder sie nicht zu shipyards Architektur passen:

FeatureGrund
Content Collection LoadersAstro Content Collections handhabt das
Static Site GenerationAstro-Kernfunktion
Plugin Lifecycle HooksAstro Integrations handhabt das
Webpack/Bundler ConfigAstro verwendet Vite nativ
React Hydration StrategiesAstro Islands Architektur handhabt das
Global Data via HooksAstros Data Fetching handhabt das
Build-time Data LoadingAstros getStaticPaths handhabt das

Prioritäts-Roadmap

Hohe Priorität (Kern-Parität)

  1. Admonitions/Callouts - ✅ Implementiert
  2. Tags für Docs und Blog - ✅ Implementiert
  3. RSS/Atom-Feeds - ✅ Implementiert
  4. Lesezeit - ✅ Implementiert
  5. Entwurfsmodus - ✅ Implementiert
  6. Vorherige/Nächste Navigation - ✅ Implementiert

Mittlere Priorität (Erweiterte Features)

  1. Such-Integration - Kritisch für größere Docs
  2. “Diese Seite bearbeiten”-Links - ✅ Implementiert
  3. Letzte Aktualisierungszeitstempel - ✅ Implementiert
  4. Code-Block-Erweiterungen - ✅ Implementiert (Zeilennummern, Highlighting, Titel)
  5. Tabs-Komponente - ✅ Implementiert
  6. Archivseite für Blog - ✅ Implementiert
  7. Ankündigungsbanner - ✅ Implementiert

Niedrigere Priorität (Erweiterte Features)

  1. Dokumentationsversionierung - Komplexes Feature für reife Projekte
  2. Multi-Instance Docs/Blogs - ✅ Implementiert (routeBasePath für Docs und Blogs)
  3. Sidebar Link-Typ - ✅ Implementiert (externe/interne Links in Sidebar)
  4. Autorenseiten - ✅ Implementiert (generierte Autorenseiten für Blog)
  5. hide_table_of_contents - ✅ Implementiert (pro-Seite TOC verstecken)
  6. Social-Card-Bilder - ✅ Implementiert (og:image, twitter:image)
  7. Dark-Mode-Toggle - ✅ Implementiert (ThemeToggle-Komponente)
  8. hide_title - ✅ Implementiert (H1-Überschrift via Frontmatter verstecken)
  9. TOC-Level-Filterung - ✅ Implementiert (toc_min/max_heading_level)
  10. Keywords SEO - ✅ Implementiert (keywords Meta-Tag)
  11. pagination_label - ✅ Implementiert (benutzerdefinierte Paginierungslabels)
  12. last_update - ✅ Implementiert (manuelle letzte Aktualisierung überschreiben)
  13. hide_sidebar - ✅ Implementiert (pro-Seite Sidebar verstecken)
  14. Blog TOC-Levels - ✅ Implementiert (toc_min/max_heading_level für Blog)
  15. Benutzerdefinierter URL-Slug - ✅ Implementiert (slug Frontmatter für Docs)
  16. Kanonische URLs - ✅ Implementiert (canonical_url Frontmatter)
  17. Tag-Beschreibungen - ✅ Implementiert (tags.yml mit Labels und Beschreibungen)
  18. Sidebar Custom Props - ✅ Implementiert (Badges via sidebar.customProps)
  19. Benutzerdefinierte Meta-Tags - ✅ Implementiert (custom_meta_tags Frontmatter)
  20. Dokument-ID - ✅ Implementiert (id Frontmatter für Paginierungsreferenzen)
  21. Pages Frontmatter - ✅ Implementiert (keywords, image, wrapperClassName, canonical_url, custom_meta_tags)
  22. Benutzerdefiniertes Sidebar-HTML - ✅ Implementiert (labelHtml und defaultStyle Eigenschaften)
  23. Multi-Instance Blogs - ✅ Implementiert (routeBasePath Konfiguration)
  24. npm2yarn Code-Blöcke - ✅ Implementiert (remarkNpm2Yarn Plugin)

Beitragen

Wir freuen uns über Beiträge um Feature-Parität mit Docusaurus zu erreichen! Wenn du eines der oben nicht markierten Features implementieren möchtest:

  1. Schau in den GitHub Issues nach bestehenden Diskussionen
  2. Eröffne ein neues Issue um deine geplante Implementierung zu besprechen
  3. Reiche einen Pull Request ein

Zuletzt aktualisiert: Januar 2026