Template
Titel des Projekts/der App mit TitleCase
Haftungsausschluss: Projekte verwalten den Inhalt dieses Leitfadens vollständig selbst. Moonbeam ist ein erlaubnisfreies Netzwerk. Jedes Projekt kann seine Verträge auf Moonbeam bereitstellen.
Einführung
Diese Datei skizziert eine Vorlage, die beim Auflisten von Projekten in diesem Verzeichnis befolgt werden sollte.
Dieser erste Abschnitt sollte eine Einführung in Ihr Projekt/Ihre App sein. Sie können Folgendes enthalten:
- Eine Erklärung auf hoher Ebene, was es tut.
- Welchen Wert es für den Benutzer hat
- Links zu wichtigen Informationen (Token Faucet, Tutorials, die Informationen, die Sie für notwendig halten)
Inhalt und Struktur
Dieser Abschnitt behandelt den Mindestinhalt, der für die Aufnahme in die Liste erforderlich ist, und die Struktur der Dateien.
Minimaler Inhalt
Im Allgemeinen muss Ihr Projekt/Ihre App die folgenden inhaltlichen Anforderungen erfüllen, um berücksichtigt und in diese Liste aufgenommen zu werden:
- Einführung (siehe den Abschnitt “Einführung”)
- Zeigen Sie funktionierende Verträge und/oder Frontends, die mit dem Moonbase Alpha TestNet verbunden sind oder eingesetzt werden
- Erklären Sie den Benutzern, wie sie Ihr Projekt/die App testen oder integrieren können
- Verlinken Sie die GitHub-Repos des Codes
- Verlinken Sie auf Kommunikationskanäle
- Anfangen
Um loszulegen, müssen Sie das folgende Repository klonen:
git clone https://github.com/PureStake/moonbeam-project-directory
cd moonbeam-project-directory
Als nächstes können Sie diese Datei (oder ihren Inhalt) kopieren und eine neue Datei in dem Repository-Ordner erstellen, der am meisten mit Ihrem Projekt zu tun hat. Nehmen wir zum Beispiel an, Ihr Projekt heißt “Rocket Project” und hat einen Bezug zu DeFi. Dann müssten Sie diese Datei in den folgenden Ordner kopieren:
moonbeam-project-directory
| — apis
| — assets
| — bridges
| — defi
| — | — rocket-project.md
| — explorers
…
Wenn sich die Datei am richtigen Ort befindet, können Sie damit beginnen, sie an Ihre Vorgaben anzupassen. Stellen Sie sicher, dass Sie den Titel, die Beschreibung und die erste Überschrift (die sich alle oben in der Datei befinden) ändern. Der Titel legt fest, wie der Eintrag im Navigationsmenü auf der linken Seite benannt wird. Die Beschreibung bezieht sich auf die Metadaten der Seite:
— -
title: Rocket Project (title example)
description: Rocket Project DeFi integration in Moonbase Alpha to access the Multi-Chain future and the Polkadot Ecosystem (description example)
— -
# Rocket Project — DeFi Multi Chain (title example)
Bilder, die zu Ihrer Dokumentation gehören, können im Ordner images im Hauptverzeichnis des Repos gespeichert werden. Bitte erstellen Sie einen Ordner, in dem Sie Ihre Bilder speichern möchten. Für unser vorheriges Beispiel wäre dies in:
moonbeam-project-directory
| — apis
…
| — defi
| — explorers
| — images
| — | — rocket-project
| — | — | — image1.png
| — | — | — image2.svg
| — marketplaces
…
Doku-Standards
Hier finden Sie einige Standardregeln zum Schreiben der Dokumentation.
Die Docs sind in regulärem Markdown geschrieben, wobei einige Plugins verfügbar sind. Als Referenz wird die Seite mit mkdocs generiert, mit einem Material-Design-Theme, das Sie hier finden können.
Wie bereits erwähnt, muss jeder Titel/jede Überschrift mit Title Case geschrieben werden. Einen unkomplizierten Konverter finden Sie hier.
Vermeiden Sie die Verwendung von H4, d.h. Überschriften mit ####.
Aufzählungslisten
Wenn sich eine Aufzählungsliste auf einige Parameterdefinitionen bezieht, verwenden Sie die folgende Struktur:
Some text here:
- **Def1** — some text here
- **Def2** — some text here
- **Def3** — some text here
- **Def4** — some text here
Einige wichtige Punkte zum Mitnehmen:
- Aufzählungszeichen sollten immer mit — beginnen, d. h. es gibt ein Leerzeichen + Bindestrich + Leerzeichen
- Der zu definierende Parameter wird fett gedruckt
- Zwischen dem Parameter und der Definition steht ein langer Bindestrich -
- Vor der Aufzählung und nach der Aufzählung muss immer ein Leerzeichen stehen
- Am Ende eines jeden Punktes steht kein .
Wenn Aufzählungslisten der Beschreibung von Schritten dienen (oder etwas anderem als der Definition von Dingen), können Sie die folgende Struktur verwenden:
Some text here:
- Some text here
- Some text here
- Some text here
- Some text here
Einige wichtige Punkte zum Mitnehmen:
Aufzählungspunkte sollten immer mit — beginnen, d. h. es gibt ein Leerzeichen + Bindestrich + Leerzeichen
Lassen Sie immer ein Leerzeichen vor und nach den Aufzählungspunkten
Am Ende eines jeden Punktes steht kein .
Bilder
Bevor Sie Bilder in Ihre Dokumentation einfügen, legen Sie bitte zunächst ein Verzeichnis (mit einem Namen, der sich auf Ihr Projekt/die App bezieht) im Ordner images an.
Wenn der Ordner erstellt ist, können Sie Ihrer Dokumentationsseite Bilder mit der folgenden Struktur hinzufügen:
Im Allgemeinen werden die meisten gängigen Bildformate unterstützt, wie z. B.: PNG, JPEG, TIFF und SVG.
Verfügbare Plugins
Viele der verfügbaren Plugins finden Sie auf dieser Dokumentseite. In diesem Abschnitt werden nur die nützlichsten verfügbaren Plugins behandelt.
Code-Schnipsel
Jeder beliebige Code, Text oder Befehl, den die Benutzer einfach kopieren und einfügen können sollen, kann mit der Code-Snippet-Funktionalität hinzugefügt werden. Dazu umschließen Sie den Code, Text und/oder Befehl mit drei aufeinanderfolgenden Backticks (````). Sie können die folgende Struktur verwenden:
```
This a code that is inside a code snippet block.
Hover over this box and you will see a click-to-copy button.
```
Einige wichtige Erkenntnisse:
Es ist gute Praxis, vor und nach dem Codeschnipsel eine Leerzeile zu lassen
Code-Snippets müssen mit mindestens drei Backticks (````) beginnen. Sie können mehr verwenden, solange Sie die gleiche Anzahl zum Öffnen/Schließen des Snippets verwenden
Sie können die Sprache des Blocks in den öffnenden Backticks angeben. Zum Beispiel können Sie für Python-Code ````python verwenden. Eine vollständige Liste der verfügbaren Lexer finden Sie hier
Registerkarten für den Inhalt
In einigen Fällen möchten Sie vielleicht alternative Inhalte unter verschiedenen Registerkarten gruppieren. Zum Beispiel beschreiben Sie einen Codeschnipsel in verschiedenen Sprachen. Mit Inhalts-Registern können Sie Inhalte in einem einzigen Block zusammenfassen. Dieser Block bietet verschiedene Registerkarten, die den Inhalt verändern, je nachdem, wie Sie ihn konfigurieren. Dazu können Sie die folgende Struktur verwenden:
=== “Option1”
```
code snippet one
```
=== “Option2”
```
code snippet two
```
=== “Option3”
```
code snippet three
Einige wichtige Erkenntnisse:
Es muss eine Leerzeile vor und nach dem Codeblock für den Tabbed Content geben
Tabbed Content ist nicht nur auf Code-Snippets beschränkt (auch wenn dies der häufigste Anwendungsfall sein dürfte). Sie können es auch mit Text und Bildern verwenden
Das Format ist streng. Das bedeutet, dass es mit drei Gleichheitszeichen (===) beginnen muss, gefolgt von einem Leerzeichen und dann dem Titel, der in Anführungszeichen eingeschlossen ist. Der Inhalt der Registerkarte muss direkt darunter aufgeführt werden, eingerückt mit vier Leerzeichen
Hinzufügen von Notizen
Die Option Notizen (!!! note) ist super hilfreich, wenn Sie möchten, dass Benutzer bestimmte Informationen lesen. Notizen können benutzerdefinierte Titel mit der folgenden Syntax haben !!! note “Your Title Here”. Dazu können Sie die folgende Struktur verwenden:
Some text here.
!!! note
This is a note. There is an empty line before the !!! note syntax,
and one right after this text. Note that this sentence will end with a dot.
Some text here
Einige wichtige Hinweise:
Es muss eine Leerzeile vor und nach dem Notenblock vorhanden sein
Zwischen !!! und Hinweis müssen Leerzeichen stehen
Der in der Notiz enthaltene Text muss um vier Leerzeichen eingerückt sein. Andernfalls wird die Notiz nicht korrekt erzeugt
Tabellen
Tabellen können ebenfalls verwendet werden und können beliebigen Markdown-Code enthalten. Als Referenz können Sie diesen Online-Tabellengenerator verwenden. Um eine Tabelle zu erstellen, können Sie die folgende Struktur verwenden:
| Table | Example |
| : — — — — -: | : — — — — — — — — — — — — -: |
| `ONE` | :one: Fetch resource |
| `TWO` | :two: Update resource |
| `Three ` | :three: Delete resource |
Mehr über Markdown-Tabellen können Sie hier lesen.
Original article: https://docs.moonbeam.network/dapps-list/template/
