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。？选项之间的空白行

在不同选项之间插入空白行，以便在视觉上分开选项。

执照

麻省理工学院