quiltmc.org
1.0.0
Site para o projeto de colcha.
Este site foi construído com Astro, MDX e I18Next. Ele está hospedado em páginas Cloudflare. Se você quiser se familiarizar com o Astro, pode ler sua documentação.
Se você ficar preso ou tiver dúvidas, junte -se a nós no thread #Website em nosso servidor Discord.
O editor mais simples de usar é o Código do Visual Studio (VSCODE), porque possui extensões oficiais de idiomas para Astro e MDX. Ao abrir o repositório no VSCode, você verá um pop-up no canto inferior direito, oferecendo para instalar algumas extensões recomendadas. Você também pode digitar @recommended na barra de pesquisa de extensão para navegar nas extensões recomendadas e instalar manualmente as que deseja.
Se você preferir não usar o VSCode, pode usar qualquer editor que suporta um subconjunto das seguintes ferramentas, com base no que está fazendo:
Como mencionado anteriormente, o site é construído usando o Astro, que está escrito no TypeScript, portanto, você precisará de um tempo de execução JavaScript compatível com Node.js para construí-lo e executá-lo para o desenvolvimento. Se você faz apenas uma contribuição simples, como um mod incompatível ou uma postagem no blog, a configuração de um ambiente de desenvolvimento não é essencial: uma versão de visualização do site será criada quando você enviar uma solicitação de tração para garantir que tudo funcione conforme o esperado.
Node.js é um tempo de execução JavaScript de plataforma cruzada. Ele pode ser instalado diretamente ou provavelmente está disponível para o seu gerenciador de pacotes favorito.
Usamos o PNPM como nosso gerenciador de pacotes Node.js. Pode ser instalado das seguintes maneiras:
npm install -g pnpmPara mais opções, consulte os documentos do PNPM.
Dentro do projeto, instale todos os pacotes necessários usando o PNPM:
pnpm i O Astro inclui um servidor de desenvolvimento que se recarrega automaticamente à medida que você altera os arquivos dentro do projeto. Para começar, execute 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...
O servidor de desenvolvimento constrói páginas enquanto você as visita para reduzir o tempo de início, para que seu desempenho seja pior que o site totalmente construído.
Para construir uma cópia completa do site final:
pnpm build
O site será incorporado na pasta dist/ . Construir o site é uma maneira útil de verificar se você não quebrou nada sem perceber.
Você pode visualizar o site construído usando pnpm astro preview , mas na maioria dos casos a única vantagem que isso tem sobre o servidor de desenvolvimento é o desempenho.
Se você precisar testar a funcionalidade específica das páginas Cloudflare (como qualquer coisa nas functions/ diretório), poderá visualizar o site usando o Wrangler Clito da Cloudflare emular uma implantação de páginas de nuvem.
Primeiro, instale o Wrangler
pnpm install -g wranglerConstrua o site:
pnpm build Execute a pasta dist em saída usando o Wrangler:
wrangler pages dev dist
Ao contrário do servidor de desenvolvimento da Astro, o Wrangler pode apenas visualizar um site totalmente construído.
Para uma explicação detalhada de como o repositório é estabelecido, consulte ARCHITECTURE.md
Instruções para fazer vários tipos comuns de contribuições.
Abra o arquivo incompatible-mods.json em public/api/v1/incompatible-mods.json e adicione uma nova entrada na parte inferior da lista.
Sua entrada deve ter os seguintes campos:
"ids": - Uma lista de IDs de moda que são afetados."Name": - o nome completo do mod afetado."type": - o tipo de incompatibilidade. Pode ser um dos seguintes:"GAME" - trava ou quebra o jogo de baunilha."OTHERS" - quebra um ou mais outros mods."SELF" - se quebra."WORKAROUND" - possui uma solução alternativa que permite funcionar corretamente."Status": - Quão perto a incompatibilidade está de ser consertada. Pode ser um dos seguintes:"BLOCKED" - os autores do Mod estão cientes do problema, mas uma correção é bloqueada por um fator externo."IN_PROGRESS" - Os autores do Mod estão implementando uma correção."NO_ANSWER" - o problema foi relatado, mas os autores do Mod não responderam."ON_HOLD" - Os autores do Mod estão esperando para implementar ou liberar a correção."UNKNOWN" - o problema não foi relatado aos autores do Mod, ou você não pode encontrar um relatório."WONT_FIX" - o problema foi relatado, mas os autores do Mod se recusam a corrigi -lo."tracking": - Um link para o relatório que rastreia a incompatibilidade, por exemplo, um problema do GitHub. Defina como "UNKNOWN" se você não souber."notes": (Opcional) - Quaisquer outras notas, por exemplo, a solução alternativa conhecida. Crie um novo arquivo de marcação no src/pages/en/blog , nomeado com a data atual e uma versão reduzida do título. A data deve estar no formato yyyy-mm-dd , e o título deve estar em minúsculas e separadas por hífens ( - ), por exemplo, 2024-03-09-example-post.md .
Na parte superior do arquivo, você precisa adicionar matéria frontal , que é metadados escritos no YAML. O assunto da frente para uma postagem no blog é assim:
---
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.
--- Escreva um primeiro parágrafo curto e, em seguida, insira duas linhas, coloque <!-- MORE --> , depois mais duas linhas. Por exemplo:
A succinct first paragraph.
<!-- MORE -->
More text here.
Isso informa ao site o que incluir na curta visualização que entra na página inicial e na lista de postagens do blog. A partir daqui, você pode continuar escrevendo o Markdown para o conteúdo do seu coração. O destaque da sintaxe nos blocos de código também é suportado.
Se você faz parte de uma das equipes de desenvolvedor ou comunidade da Quilt, provavelmente terá um cartão na página de listagens de equipes do site. Os dados dentro dos cartões nesta página são criados a partir do arquivo TeamData.mjs no src/data/ .
Cada membro da equipe tem um objeto neste arquivo com dados sobre eles. A (s) seção (s) da página em que você está listada é baseada em quais equipes você está no Github.
Você pode alterar os seguintes dados para personalizar seu cartão:
name: - O nome na parte superior do seu cartão. Pode ser o que você quiser.discord: - seu nome de usuário da discórdia.github: - Seu nome de usuário do Github. Isso é usado para identificar em quais equipes você está no Github.avatar: - Este é um URL para qualquer imagem que você quiser. Para obter melhores resultados, deve ser quadrado e não muito grande. Você pode colocar um arquivo em public/assets/team/images para hospedá -lo no site ou usar qualquer outro URL de imagem que desejar.description: (Opcional) - Uma frase ou um pequeno parágrafo sobre quem você é.links: (Opcional) - Uma lista de links para suas várias páginas da Web ou perfis de mídia social. Cada link é representado pelo seguinte objeto:icon : um ícone que representa o link. Você pode escolher entre as marcas CoreUi ( cib: , ícones de design de materiais ( mdi: :) ou símbolos de material ( material-symbols: ; ou use nossos ícones personalizados para Curseforge ( curseforge ) e modrinth ( modrinth-small ). Ao usar um ícone de um conjunto de ícones (em oposição a um personalizado), você deve prefixar o nome do ícone com o nome do conjunto de ícones, por exemplo, cib:youtube para usar o ícone youtube das marcas CoreUi.url : O link para a página da web.systemMembers: (Opcional) - Este campo é destinado a sistemas plurais para exibir cada um de seus membros. Tem alguns valores possíveis:"---" mostrará você como um sistema plural com seus membros escondidos.name: o nome do membro do sistema.icon: - Um avatar para o membro. Você pode usar qualquer URL desejar ou hospedar uma imagem neste site em public/assets/team/images/<your-system-name>/ .
