markdown dungeon

⚔ Dungeon Markdown ⚔

Подземелье - это место или тюрьма, где находятся люди. Обычно их можно найти под землей

Это пример репо -иллюстрации подземелья с использованием Markdown на GitHub. В подземелье читатель выбирает, какой вариант взять и прыгать на соответствующую страницу комнаты, основанной на их выборе. Это совместно, потому что комната написана многими авторами.

Начните новую игру

? Установка

Вам нужно установить пряжу.

1. Клонировать репо

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

2. Перейти к папке

 cd markdown-dungeon

3. Запустите установить зависимость

yarn

4. Создайте файл .env.development в папке Project Root и скопируйте формат файла .env.example .
5. Чтобы запустить запуск сервера разработки:

yarn start

Убедитесь, что вы не используете PowerShell

6. ? Откройте свой браузер и перейдите по адресу http: // localhost: 8000/или http: // localhost: 8000/___ graphql

Пол и формат комнаты

Пол - это папка, а каждый этаж - это коллекция комнат , а каждая комната - файл Markdown . Ссылки возможностей разметки используются для вверх/вниз и для перейти в другую комнату, например, пример ниже.

Перейти в подземелье GitHub

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

‍ Руководство по вкладу

1.? Внести изменения в адекватный размер

• Держите изменения маленькими
• Не добавляйте опцию, не добавляя ворота для читателей, которые решают эту опцию, чтобы подземелье не было полным мертвых ссылок. Вместо этого, последний файл разметки, который читатель достигает на любом пути комнаты, не должен иметь никаких вариантов.

Вот несколько примеров соответствующих изменений:

• Добавьте одно или два предложения на существующую «страницу» (файл) в комнату.
• Добавьте новую опцию в существующую точку выбора и свяжите эту опцию с существующей «комнатой» или «полом».
• Добавьте новую опцию в существующую точку выбора, создайте новую «страницу» для этой опции и добавьте предложение или два на новую «страницу».
• Добавьте пару параметров на текущую тупиковую «страницу» и добавьте «страницу» или ссылку на существующую «страницу» для каждой опции.

2. ⛩ Структура подземелья

Структура должна быть dungeon-name/floor-number/room-number , пожалуйста, смотрите определения ниже для каждой переменной:

• Dungeon-name: это папка, которая содержит номер пола, должен разделять слова с помощью приборной (-), является буквенно-цифровой. Пример: Нормальный Dungeon-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 (-).

Если вы создали новое подземелье, добавьте, добавьте новую игру, добавьте ее в папку изображений и в Dungeon-info.json, чтобы читатель мог перейти в ваше подземелье и открыть его на веб-сайте

Если вы хотите получить представление о том, какой вариант приводит к тому, что при вклад, ищите файл decision_tree.png в любой папке Dungeon, которая содержит графическое представление об этом подземелье.

3.? Используйте относительные ссылки

Ссылки в этом файле должны быть относительными ссылками для продолжения работы, если репозиторий раздвоен.

4.? Длина линии

Держите все строки 120 символов или меньше. В противном случае файлы RAW будут трудно читать в браузере или в командной строке, и изменения будут сложнее просмотреть.

5.? Пустые линии между опциями

Вставьте пустые линии между различными параметрами, чтобы параметры визуально разделены.

Лицензия

Грань