Инструкция для подачи материалов
Здраствуйте! Эта инструкция поможет всем заинтересованным в подаче своих материлов для нри Cairn на этот сайт. Все страницы написаны на языке Markdown и отправляются через git (наилучший способ описанный ниже). Однако, если процесс показался вам слишком затруднительным, вы можете зайти в наш чат в телеграмме. Там вы сможете задать вопрос или попросить о помощи.
Markdown
Markdown — это язык вёрстки, который использует простые символы для создания красивого форматирования. Например, если вы хотите что-то выделить жирным, то отмечьте в документе при помощи ** в начале и конце места выделения (т.е. **жирный** станет жирный). При знании английского можно прочитать эту инструкцию (на английском) для наилучшего форматирования.
Для создания нужной вам страницы на сайте, сделайте текстовый файл со всем нужным и обозначите его как файл Markdown расширения .md. Github сделает за вас остальное!
Создание файла markdown
- Для создания текстового файла с расширением .md подойдет любой вами любимый текстовый редактор, самые популярными из них являются Microsoft Notepad, Visual Studio Code и ViM. Мы рекомендуем GhostWriter и VS Code
- Напишите весь текст соблюдая формат Markdown в ваш текстовый файл. Просим также соблюдать Стиль документов при написании вашего материала!
- Сохраните файл в нужной папке на сайте через Github (см. ниже).
Как мне подать материал на сайт?
Через Github
- Сначала создайте себе аккаунт на Gihub, зайдите на репозиторий и сделайте его “fork”. Советуйтесь со странице «Форкни это!» и документации Github
Теперь вы создали свою собственную версию сайта, которая принадлежит именно вам. Она сделана на базе оригинальных файлов (в Github это назвывается “репозитория”), но оригинальный сайт не смотрит на твою копию файлов. Это позволяет вам свободно менять и играться с файлами не меняя файлы на оригинальном сайте.
- Если вы хотите работать с файлами на своём локальном компьютере, то установите git.
Этот способ позволяет вам редактировать файлы вашей программой на выбор, а не в бразуере. Сохраняя возомжность скачивать и отправлять файлы на Github.
- Сделайте клон репозитория на ваш компьютер. Рекомендуем эту инструкцию.
- Этот способ массово скачивает файлы на ваш компьютер, создавая облик вашего репозитория.
Папки
Файлы должны лежать в следующих папках:
- Перенос приключения (см. Шаблон материалов)
- Оригинальные приключения
- Стороние хаки
- Монстры
- Общие ресурсы
Пуш изменений
Общий алгоритм работы заключается в редактрировании файлов в вашей локальной копии, затем .
- Используйте комманду commit в Git для закрепления изменений.
- Используйте комманду push для отправки изменений на Github.
- Вы загрузили новые файлы и изменения в свою репозиторию на Github.
- Используя Github, создайте pull request в изначальную Github репозиторию.
- Подмечу, что этот шаг отличается тем, что требует человеческого вмешательства. Ментейнерам основного репозитория нужно будет подтвердить или опровергнуть запрос на pull ваших изменений.
- Подождите когда внесут ваши изменения.
Дальнейшая помощь
Если вы хотите получить дополнительную помощь, включая техническую. Напишите вашу просьбу в чат в Телеграме. В особенности, перевод сайта был сделан Вариком (@thevarik), и его легко найти в телеграмме.