markdown dungeon Download - markdown dungeon Source Code Download

markdown dungeon

Anderer Quellcode

1.0.0

Herunterladen

⚔️ Markdown Dungeon ⚔️

Ein Dungeon ist ein Ort oder ein Gefängnis, an dem Menschen festgehalten werden. Normalerweise können sie unter der Erde gefunden werden

Dies ist ein Beispiel für Repo -Abbildung eines Dungeons mit Markdown auf GitHub. Im Dungeon wählt der Leser aus, welche Option ergreifen soll, und springt in eine geeignete Seite des Raums, die auf ihrer Wahl basiert. Es ist kollaborativ, weil der Raum von vielen Autoren geschrieben wurde.

Starten Sie ein neues Spiel

? Installation

Sie müssen Garn installieren.

Klonen Sie das Repo

git clone https://github.com/MakeContributions/markdown-dungeon.git

In den Ordner gehen

 cd markdown-dungeon

Installieren Sie die Abhängigkeit aus

yarn

Erstellen Sie eine .env.development -Datei im Projektstammordner und kopieren Sie das Format von .env.example -Datei.
Um den Entwicklungsserver zu starten:

yarn start

Stellen Sie sicher, dass Sie PowerShell nicht verwenden

? Öffnen Sie Ihren Browser und gehen Sie zu http: // localhost: 8000/oder http: // localhost: 8000/___ Graphql

Boden und Raumformat

Ein Boden ist ein Ordner und jede Etage ist eine Sammlung von Räumen und jeder Raum ist eine Markdown -Datei. Die Markdown -Funktionsverbindungen werden für UP/Down verwendet und in einen anderen Raum wie das folgende Beispiel gehen.

Geh zum Github Dungeon

 [ Go to Github dungeon ] ( https://github.com/ )

? ‍ Beitragsrichtlinien

1.? Änderungen ausreichend Größe vornehmen

Veränderungen klein halten
Fügen Sie keine Option hinzu, ohne ein Tor für Leser hinzuzufügen, die sich für diese Option entscheiden, damit der Dungeon nicht voller toter Links ist. Stattdessen sollte die letzte Markdown -Datei, die der Leser auf einem beliebigen Weg des Raums erreicht, keine Optionen haben.

Hier sind einige Beispiele für geeignete Änderungen:

Fügen Sie ein oder zwei Sätze einer vorhandenen "Seite" (Datei "(Datei) im Raum hinzu.
Fügen Sie einem vorhandenen Auswahlpunkt eine neue Option hinzu und verlinken Sie diese Option mit einem vorhandenen "Raum" oder "Boden".
Fügen Sie einem vorhandenen Auswahlpunkt eine neue Option hinzu, erstellen Sie eine neue "Seite" für diese Option und fügen Sie der neuen "Seite" ein oder zwei Sätze hinzu.
Fügen Sie ein paar Optionen zu einer aktuellen "Seite" Seite "Seite" hinzu und fügen Sie für jede Option eine "Seite" oder einen Link zu einer vorhandenen "Seite" hinzu.

2. ⛩ Dungeon -Struktur

Die Struktur sollte dungeon-name/floor-number/room-number sein. Weitere Informationen finden Sie in den folgenden Definitionen für jede Variable:

Dungeon-Name: ist ein Ordner, der Bodennummer enthält, sollte Wörter mit einem Armaturenbrett trennen (-), ist alphanumerisch. Beispiel: Normal-Dungeon-1 .
Bodennummer: Ist ein Ordner, der die Zimmernummer enthält, ist numerisch. Fügen Sie nicht 0 vor der Nummer hinzu.

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

Raumnummer: Ist eine Markdown-Datei, der Name der Datei sollte in numerischer Weise enthalten sein. Wenn Sie jedoch Unterbereiche des Raumes haben, können Sie die Zimmernummer mit einem Armaturenbrett (-) trennen, der Unterraum könnte alphanumerisch sein.

 1, 2, 3-AF, 3-01 // Compliance

01A, 02*A3, A3+F // Non-Compliance

Ordner oder Dateiname akzeptieren nur alle ASCII-Zeichen und den Dash (-).

Wenn Sie einen neuen Dungeon erstellt haben

Wenn Sie eine Vorstellung davon bekommen möchten, welche Option zu dem führt, was beim Beitrag zu einer Datei decision_tree.png unter einem Dungeon -Ordner suchen, der eine grafische Ansicht dieses Dungeons enthält.

3.? Verwenden Sie relative Links

Die Links in dieser Datei müssen relative Links sein, um weiter zu arbeiten, wenn das Repository aufgetaucht ist.

4.? Linienlängen

Halten Sie alle Zeilen 120 Zeichen oder weniger. Andernfalls sind die Rohdateien schwer im Browser oder in der Befehlszeile zu lesen, und die Änderungen sind schwieriger zu überprüfen.