Introdução

O Starlight é um tema de documentação cheio de funcionalidades construído em cima do framework Astro. Este guia irá ajudá-lo a começar um novo projeto. Consulte as instruções de instalação manual para adicionar o Starlight a um projeto Astro já existente.

Início Rápido

Crie um novo projeto

Crie um novo projeto Astro + Starlight executando o seguinte comando no seu terminal:

npm

npm create astro@latest -- --template starlight

pnpm

pnpm create astro --template starlight

Yarn

yarn create astro --template starlight

Isto irá criar um novo diretório de projeto com todos os arquivos e configurações necessárias para o seu novo site.

Veja-o em ação

Experimente o Starlight directamente no seu navegador: abrir o template no StackBlitz.

Inicie o servidor de desenvolvimento

Quando estiver a trabalhar localmente, o servidor de desenvolvimento do Astro permitirá visualizar seu trabalho e atualizar automaticamente o seu navegador após fazer alterações.

Dentro do diretório do seu projeto, execute o seguinte comando para iniciar o servidor de desenvolvimento:

npm

npm run dev

pnpm

pnpm dev

Yarn

yarn dev

Será exibida uma mensagem no seu terminal com o URL para a visualização local. Abra esse URL para começar a navegar no seu site.

Crie conteúdo

O Starlight está pronto para você adicionar novos conteúdos, ou trazer os seus arquivos existentes!

Adicione páginas ao seu site criando ficheiros Markdown no directório src/content/docs/.

Saiba mais acerca de routing baseado em ficheiros e suporte para ficheiros MDX e Markdoc no guia “Páginas”.

Próximos passos

• Configurar: Descubra opções comuns em “Customização do Starlight”.
• Navegar: Configure a barra lateral com o guia “Barra lateral de navegação”.
• Componentes: Conheça os cartões, separadores e outros componentes integrados no guia “Componentes”.
• Deploy: Publique o seu projeto com a ajuda do guia “Deploy do seu site Astro” na documentação do Astro.

Atualizar o Starlight

Dica

Como o Starlight é um software em beta é normal que ocorram atualizações e melhorias frequentes. Certifique-se que atualiza o Starlight constantemente!

O Starlight é uma integração do Astro. Pode atualizá-lo, como outros pacotes Astro, executando no seu terminal o seguinte comando:

npm

npx @astrojs/upgrade

pnpm

pnpm dlx @astrojs/upgrade

Yarn

yarn dlx @astrojs/upgrade

Consulte o histórico de mudanças do Starlight para ver a lista completa das alterações feitas em cada versão.

Solucionar Problemas no Starlight

Utilize as páginas de referência configuração do projeto e configuração do frontmatter para cada página para garantir que seu site Starlight está configurado e a funcionar corretamente. Confira os guias na barra lateral para ajudá-lo a adicionar conteúdo e a personalizar o seu site Starlight.

Se não encontrar a sua resposta nesta documentação, visite por favor a documentação do Astro para consultar uma documentação mais completa sobre o Astro. A sua dúvida pode ser respondida se entender como é que o Astro funciona no geral e por debaixo do tema Starlight.

Pode ainda procurar por problemas conhecidos do Starlight no GitHub, e obter ajuda no Discord do Astro com a nossa ativa e amigável comunidade! Envie perguntas no nosso fórum #support com a tag “starlight”, ou visite o canal dedicado #starlight para discutir o desenvolvimento atual e mais!