Dokumentationsformat

Das Wiki verwendet MDX Dateien als Dokumentationsformat. Zusätzlich ist auch GitHub Flavored Markdown (GFM) verfügbar, das mit remark-gfm funktioniert.

Falls du noch nicht mit MDX vertraut bist, keine Sorge – es ist eine Erweiterung des einfachen Markdown Formats mit zusätzlichen JSX-Funktionen, was bedeutet, dass du in deiner Dokumentation coole benutzerdefinierte Komponenten einfügen kannst, wie zum Beispiel Minecraft Rezepte.

Diese Funktionen sind völlig optional, und du kannst immer beim Standard-Markdown für deine Dokumentation bleiben. Die Dateiendung muss jedoch .mdx bleiben.

Einschränkungen

Da MDX potenziell unerwünschte Code-Injektionen auf dem Server ermöglichen könnte, sanitieren wir alle Quellen, bevor sie gerendert werden, was dazu führen kann, dass bestimmte Funktionen von MDX nicht verfügbar sind. Falls es jedoch eine sichere Funktion gibt, die du in deiner Dokumentation verwenden möchtest und die auf dem Wiki nicht verfügbar ist, eröffne bitte ein Issue in unserem GitHub-Repository.

Metadaten

Markdown-Seitenmetadaten, auch bekannt als "Frontmatter", werden vom Wiki verwendet, um zusätzliche Informationen über eine Seite oder In-Game-Inhalte bereitzustellen. Sie befinden sich ganz am Anfang jeder Datei im YAML-Format.

Die aus dem Frontmatter gewonnenen Informationen werden dann in der rechten Seitenleiste jeder Seite unter "Informationen" angezeigt. In der Regel umfasst dies ein Icon des Blocks/Items zusammen mit seinem Namen, seiner ID, der Quelle des Projekts und anderen nützlichen Informationen.

Wenn deine Seite nicht mit einem bestimmten Objekt verbunden ist, kannst du alle Metadaten ausblenden und ihre Werte ignorieren, indem du hide_meta: true setzt. Das Attribut title wird dennoch verwendet, und wir empfehlen, es immer anzugeben.

---
title: Hello World
---

Content comes here

Hier ist eine Übersicht der unterstützten Attribute:

• title - Anzeigename der Seite, wird in der Inhaltsüberschrift und im Browser-Tab-Titel angezeigt. Ersetzt die h1-Überschrift in der Dokumentation.
  • Typ: string
  • Beispiel: Fancy Block
• hide_meta - Blendet die Metainformationen in der Seitenleiste aus. Als Ergebnis werden alle anderen Attribute ignoriert.
  • Typ: boolean
• id - In-Game-Resource-Location-ID des angezeigten Inhalts. Wenn ein passendes Asset mit derselben Location im Asset-Ordner des Dokumentations-Roots gefunden wird, wird es als icon verwendet.
  • Typ: Resource Location
  • Beispiel: examplemod:generator
• icon - Resource-Location eines Assets, das als Icon des dokumentierten Items angezeigt wird. Es sollte mindestens 128x128 Pixel groß sein.
  • Typ: Resource Location
  • Beispiel: examplemod:fancy_generator
• hide_icon - Blendet das Projekt-Icon aus und zeigt stattdessen einen generischen Platzhalter an.
  • Typ: boolean
• type - Kann block, item oder other sein.
  • Typ: string
• custom - Eine Zuordnung von benutzerdefinierten Attributen, die du in der Seitenleiste anzeigen möchtest.
  • Typ: string -> string Zuordnung
  • Beispiel:

    custom:
      Category: Machines

---
title: Generator
id: examplemod:generator
icon: examplemod:fancy_generator
type: block
custom:
  Subcategory: Machines
---

Inhalt kommt hier

Benutzerdefinierte Komponenten

Das Wiki fügt eine Auswahl nützlicher Komponenten hinzu, die du in deiner Dokumentation verwenden kannst.

Import-Anweisungen sind für die eingebauten Wiki-Komponenten nicht erforderlich.

Rezepte

• slots - Genau 9 Resource-Location-Strings (Asset-Namen), in der Reihenfolge von oben links nach unten rechts.
• result - Resource-Location des resultierenden Item-Assets
• count - Optional, die Menge des Ausgabeelements angeben

※ Die in Rezepten angezeigten Bilder stammen aus Dokumentations-Assets, wie hier beschrieben.

<CraftingRecipe
    slots={[
        'flint',
        'minecraft:flint', // Hinweis: Der Namespace ist für 'minecraft'-Items optional
        'flint',
        '',
        'iron_block',
        '',
        '',
        'diamond',
        ''
    ]}
    result="furnace"
    count={4} // Optional
/>

Ergebnis:

4

Hinweise

Lenke die Aufmerksamkeit der Leser mit Hinweisen.

Verfügbare Attribute:

• variant Optional; kann einer der Werte [default, info, warning, danger] sein (Standard: default)

<Callout>
    Dies ist ein Beispielhinweis
</Callout>

<Callout variant="info">
    Dies ist ein Beispiel-Info-Hinweis
</Callout>

/* Weitere Varianten siehe unten */

Ergebnis:

Info-Variante:

Warnung-Variante:

Gefahr-Variante:

Projekt Asset

Zeigt ein Asset-Bild an.

Verfügbare Attribute:

• location Erforderlich, die Resource-Location des Assets, das du anzeigen möchtest
• Alle Eigenschaften von img außer src werden akzeptiert

<Asset width={64} height={64} location="minecraft:furnace" title="Force Field Projector" />

Ergebnis:

Icons

Die gesamte Sammlung der Lucide-Icons steht zur Verwendung in Dokumentationsdateien über React-Komponenten zur Verfügung.

Die Namen der Icon-Komponenten bestehen aus dem "Komponentennamen" des Icons (den du auf der Website finden kannst oder durch eine informierte Annahme, indem du die Icon-ID in PascalCase umwandelst, z. B. align-vertical-justify-start -> AlignVerticalJustifyStart) und dem Suffix Icon. Alle Eigenschaften, die von Lucide React unterstützt werden, sind ebenfalls verfügbar.

Zum Beispiel:

<SquirrelIcon width={64} height={64} strokeWidth={1.5} />

Ergebnis:

Nächste Schritte

Sobald dein Dokumentationsordner eingerichtet ist und du mit dem Aussehen und Inhalt deiner Dokumentation zufrieden bist, ist es Zeit, sie auf dem Wiki zu veröffentlichen.

➡️ Siehe die Veröffentlichungs-Seite für weitere Informationen.