quiltmc.org
1.0.0
Веб -сайт для проекта стеганого одеяла.
Этот сайт построен с Astro, MDX и I18Next. Он размещен на страницах CloudFlare. Если вы хотите узнать больше с Astro, вы можете прочитать его документацию.
Если вы застряли или у вас есть вопросы, присоединяйтесь к нам в потоке #Website на нашем сервере Discord.
Самый простой редактор для использования - это Visual Studio Code (VSCODE), потому что он имеет официальные языковые расширения для Astro и MDX. Когда вы откроете репозиторий в VSCODE, вы увидите всплывающее окно в правом нижнем углу, чтобы установить некоторые рекомендуемые расширения. Вы также можете ввести @recommended в строке поиска расширения, чтобы просмотреть рекомендуемые расширения и вручную установить те, которые вы хотите.
Если вы предпочитаете не использовать VSCODE, вы можете использовать любой редактор, который поддерживает подмножество следующих инструментов, в зависимости от того, что вы делаете:
Как упоминалось ранее, веб-сайт строится с использованием Astro, который написан в TypeScript, поэтому вам понадобится Node.js-совместимое время выполнения JavaScript, чтобы создать и запустить его для разработки. Если вы вносите только простой вклад, такой как несовместимый мод или сообщение в блоге, настройка среды разработки не имеет важного средства: предварительная версия сайта будет построена при отправке запроса на притяжение, чтобы все было работает так, как и ожидалось.
Node.js-это кроссплатформенное время выполнения JavaScript. Он может быть установлен напрямую или, вероятно, доступен для вашего любимого менеджера пакетов.
Мы используем PNPM в качестве нашего менеджера пакетов Node.js. Он может быть установлен следующими способами:
npm install -g pnpmДля получения дополнительных вариантов см. Документы PNPM.
Внутри проекта установите все необходимые пакеты с помощью PNPM:
pnpm i Astro включает в себя сервер разработки, который автоматически перезагружается при изменении файлов внутри проекта. Чтобы начать, запустите pnpm dev :
> pnpm dev
15:05:32 [types] Generated 1ms
astro v4.15.2 ready in 702 ms
┃ Local http://localhost:4321/
┃ Network use --host to expose
15:05:32 watching for file changes...
Dev Server создает страницы, когда вы посещаете их, чтобы сократить время запуска, поэтому его производительность хуже, чем полностью построенный сайт.
Чтобы построить полную копию финального сайта:
pnpm build
Сайт будет встроен в папку dist/ . Создание сайта - это полезный способ проверить, что вы ничего не сломали, не заметив.
Вы можете предварительно просмотреть встроенный сайт, используя pnpm astro preview , но в большинстве случаев единственным преимуществом, которое это имеет по сравнению с сервером DEV, является производительность.
Если вам нужно проверить функциональность CloudFlare, специфичные для страниц (например, что-либо в functions/ каталоге), вы можете просмотреть сайт, используя клито CloudFlare Wrangler Clito, подражая развертыванию страниц CloudFlare.
Во -первых, установите Wrangler
pnpm install -g wranglerСоздайте сайт:
pnpm build Запустите выведенную папку dist с помощью Wrangler:
wrangler pages dev dist
В отличие от Astro Dev Server, Wrangler может предварительно просмотреть только сайт, который полностью построен.
Подробное объяснение того, как выложен репозиторий, см ARCHITECTURE.md
Инструкции по внесению различных общих типов вкладов.
Откройте файл incompatible-mods.json в public/api/v1/incompatible-mods.json и добавьте новую запись в нижней части списка.
Ваша запись должна иметь следующие поля:
"ids": - Список идентификаторов мод, которые затронуты."Name": - Полное имя пораженного мода."type": - Тип несовместимости. Может быть одним из следующих:"GAME" - разбивает или ломает ванильную игру."OTHERS" - ломает один или несколько других модов."SELF" - ломается."WORKAROUND" - имеет обходной путь, который позволяет ему функционировать должным образом."Status": - Насколько близко быть несовместимости быть исправленной. Может быть одним из следующих:"BLOCKED" - авторы мода знают об этой проблеме, но исправление блокируется внешним фактором."IN_PROGRESS" - авторы мода реализуют исправление."NO_ANSWER" - проблема была зарегистрирована, но авторы MOD не ответили."ON_HOLD" - авторы мода ждут, чтобы реализовать или выпустить исправление."UNKNOWN" - о проблеме не сообщалось авторам MOD, или вы не можете найти отчет."WONT_FIX" - проблема была зарегистрирована, но авторы мода отказываются исправить это."tracking": - Ссылка на отчет, отслеживающую несовместимость, например, проблема GitHub. Установите "UNKNOWN" если не знаете."notes": (необязательно) - любые другие заметки, например, известный обходной путь. Создайте новый файл Markdown в src/pages/en/blog , названном с текущей датой и сокращенной версией заголовка. Дата должна быть в формате yyyy-mm-dd , а заголовок должен быть в строчных регистрах и разделена дефисами ( - ), например, 2024-03-09-example-post.md .
В верхней части файла вам необходимо добавить фронтальное вещество , которое является метаданным, написанным в YAML. Передняя вещество для сообщения в блоге выглядит следующим образом:
---
title : " An Example Title " # The full title of the post
date : 2024-09-03 20:00:00 -00:00 # The date, time, and timezone that the post was written, relative to UTC. It is best practice to give the time in UTC and use an offset of -00:00, as shown.
authors : # A list of one or more authors
- Pineapple
layout : /src/layouts/Post.astro # This tells Astro what layout to use for the page, and should always be the same.
--- Напишите короткий первый абзац, затем вставьте две строки, положите <!-- MORE --> , затем еще две строки. Например:
A succinct first paragraph.
<!-- MORE -->
More text here.
Это сообщает веб -сайту, что включить в короткий предварительный просмотр, который идет на домашней странице и в списке сообщений в блоге. С этого момента вы можете продолжать писать отметку в содержание своего сердца. Синтаксическое выделение в блоках кода также поддерживается.
Если вы являетесь частью одного из разработчиков Quilt или общественных команд, у вас, вероятно, есть карта на странице списков команд на сайте. Данные внутри карт на этой странице построены из файла TeamData.mjs в src/data/ .
У каждого члена команды есть объект в этом файле с данными о них. Раздел (ы) страницы, на которой вы перечислены, основан на том, в каких командах вы находитесь на GitHub.
Вы можете изменить следующие данные для настройки своей карты:
name: - Имя в верхней части вашей карты. Это может быть все, что вы хотите.discord: - Ваше имя пользователя Discord.github: - Ваше имя пользователя GitHub. Это используется, чтобы определить, в каких командах вы находитесь на GitHub.avatar: - Это URL для любого изображения, которое вам нравится. Для достижения наилучших результатов это должно быть квадратным и не слишком большим. Вы можете поместить файл в public/assets/team/images , чтобы он размещен на веб -сайте, или использовать любой другой URL -адрес изображения, который вам нравится.description: (Необязательно) - предложение или небольшой абзац о том, кто вы есть.links: (необязательно) - Список ссылок на различные веб -страницы или профили социальных сетей. Каждая ссылка представлена следующим объектом:icon : значок, который представляет ссылку. Вы можете выбрать из наборов значков бренды Coreui ( cib: , значки дизайна материала ( mdi: :) или материалы символов ( material-symbols: :); или используйте наши пользовательские значки для CurseForge ( curseforge ) и Modrinth ( modrinth-small ). При использовании значка из набора значков (в отличие от пользовательского), вы должны префикс название значка с именем набора значков, например, cib:youtube , чтобы использовать значок youtube от брендов Coreui.url : ссылка на веб -страницу.systemMembers: (необязательно) - Это поле предназначено для систем множественного числа для отображения каждого из своих членов. Он имеет несколько возможных значений:"---" покажет вам как систему множественного числа со скрытыми членами.name: имя члена системы.icon: - Аватар для участника. Вы можете использовать любой URL, который вы хотите, или размещать изображение на этом сайте на public/assets/team/images/<your-system-name>/ .
