markdown dungeon

⚔️MarkdownDungeon⚔️

地牢是被人們關押的地方或監獄。通常，可以在地下找到它們

這是使用Github上的Markdown的地牢的示例回購插圖。在地牢中，讀者選擇了哪種選項並跳入基於他們選擇的房間的適當頁面。這是協作的，因為房間是由許多作者撰寫的。

開始新遊戲

？安裝

您需要安裝紗線。

1. 克隆倉庫

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

2. 轉到文件夾

 cd markdown-dungeon

3. 運行安裝依賴項

yarn

4. 在項目root文件夾中創建.env.development文件，然後復制.env.example文件的格式。
5. 啟動開發服務器運行：

yarn start

確保您不使用PowerShell

6. ？打開瀏覽器，然後訪問http：// localhost：8000/或http：// localhost：8000/___ graphql

地板和房間格式

地板是一個文件夾，每個地面都是一個房間的集合，每個房間都是Markdown文件。 Markdown功能鏈接用於向上/向下，然後去另一個房間，如下所示。

去Github地下城

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

？ ‍貢獻指南

1。 ？進行適當的更改

• 保持較小的變化
• 不要在不添加任何決定該選項的讀者的情況下添加選項，以使地牢不會充滿死鏈接。取而代之的是，讀者在房間的任何路徑上到達的最後一個標記文件不應有任何選擇。

以下是適當更改的一些示例：

• 在房間中的現有“頁面”（文件）中添加一個或兩個句子。
• 將新選項添加​​到現有選擇點，然後將該選項鍊接到現有的“房間”或“地板”。
• 在現有選擇點上添加新選項，為該選項創建一個新的“頁面”，然後在新的“頁面”中添加一兩個句子。
• 在當前的死端“頁面”中添加幾個選項，並為每個選項添加“頁面”或鏈接到現有的“頁面”。

2。 ⛩地牢結構

結構應為dungeon-name/floor-number/room-number ，請參閱下面的每個變量的定義：

• 地牢名稱：是一個包含地板號的文件夾，應用儀表板（ - ）分開單詞，為字母數字。示例：正常登記1 。
• 地板數：是一個包含房間號的文件夾，是數字在數字之前不會添加0 。

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• 房間數：是一個降價文件，文件的名稱應為數字，但是如果房間的子房間可以用儀表板（ - ）分開房間號，則子房間可能是字母數字。

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

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

文件夾或文件名僅接受所有ASCII字符和DASH（ - ）。

如果您創建了一個新的地牢，請添加啟動新遊戲，將其添加到Images文件夾中，然後在Dungeon-info.json中添加，這樣讀者可以轉到您的地牢並在網站上打開它

如果您想了解哪個選項會導致貢獻時，請在任何地牢文件夾下查找decision_tree.png文件，其中包含該地牢的圖形視圖。

3。 ？使用相對鏈接

該文件中的鏈接必須是相對鏈接，以便如果存儲庫分叉，則必須繼續工作。

4。 ？線長度

保持所有行120個或更少的字符。否則，原始文件將很難在瀏覽器或命令行中讀取，並且更改將更難查看。

5。 ？選項之間的空白行

在不同選項之間插入空白行，以便在視覺上分開選項。

執照

麻省理工學院