Dentro do AstroPaper, você verá as seguintes pastas e arquivos:
/
├── public/
│ ├── assets/
│ │ └── logo.svg
│ │ └── logo.png
│ └── favicon.svg
│ └── astropaper-og.jpg
│ └── robots.txt
│ └── toggle-theme.js
├── src/
│ ├── assets/
│ │ └── socialIcons.ts
│ ├── components/
│ ├── content/
│ │ | blog/
│ │ | └── some-blog-posts.md
│ │ └── config.ts
│ ├── layouts/
│ └── pages/
│ └── styles/
│ └── utils/
│ └── config.ts
│ └── types.ts
└── package.json
O Astro procura arquivos .astro
ou .md
no diretório src/pages/
. Cada página é exposta como uma rota com base no nome do arquivo.
Quaisquer ativos estáticos, como imagens, podem ser colocados no diretório public/
.
Todas as postagens do blog são armazenadas no diretório src/content/blog
.
A documentação pode ser lida em dois formatos: markdown e postagem no blog .
Para AstroPaper v1, verifique este branch e este URL ativo
Estrutura Principal - Astro
Verificação de tipo - TypeScript
Estrutura de componentes - ReactJS
Estilo - TailwindCSS
UI/UX - Arquivo de design Figma
Pesquisa difusa - FuseJS
Ícones - Boxicons | Mesas
Formatação de código – mais bonita
Implantação – Páginas Cloudflare
Ilustração na página Sobre - https://freesvgillustration.com
Linting - ESLint
Você pode começar a usar este projeto localmente executando o seguinte comando no diretório desejado:
# npm 6.x
npm create astro@latest --template satnaing/astro-paper
# npm 7+, extra double-dash is needed:
npm create astro@latest -- --template satnaing/astro-paper
# yarn
yarn create astro --template satnaing/astro-paper
# pnpm
pnpm dlx create-astro --template satnaing/astro-paper
Aviso! Se você estiver usando
yarn 1
, talvez seja necessário instalarsharp
como uma dependência.
Em seguida, inicie o projeto executando os seguintes comandos:
# install dependencies
npm run install
# start running the project
npm run dev
Como abordagem alternativa, se você tiver o Docker instalado, poderá usá-lo para executar este projeto localmente. Veja como:
# Build the Docker image
docker build -t astropaper .
# Run the Docker container
docker run -p 4321:80 astropaper
Você pode adicionar facilmente sua tag HTML de verificação de site do Google no AstroPaper usando uma variável de ambiente. Esta etapa é opcional. Se você não adicionar a seguinte variável de ambiente, a tag google-site-verification não aparecerá na seção HTML <head>
.
# in your environment variable file (.env)
PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value
Veja esta discussão para adicionar AstroPaper ao Google Search Console.
Todos os comandos são executados na raiz do projeto, em um terminal:
Observação! Para comandos
Docker
devemos tê-lo instalado em sua máquina.
Comando | Ação |
---|---|
npm install | Instala dependências |
npm run dev | Inicia o servidor de desenvolvimento local em localhost:4321 |
npm run build | Crie seu site de produção para ./dist/ |
npm run preview | Visualize seu build localmente, antes de implantar |
npm run format:check | Verifique o formato do código com Prettier |
npm run format | Formate códigos com Prettier |
npm run sync | Gera tipos TypeScript para todos os módulos Astro. Saber mais. |
npm run lint | Lint com ESLint |
docker compose up -d | Execute o AstroPaper no docker, você pode acessar com o mesmo nome de host e porta informados no comando dev . |
docker compose run app npm install | Você pode executar qualquer comando acima no contêiner do docker. |
docker build -t astropaper . | Construa uma imagem Docker para AstroPaper. |
docker run -p 4321:80 astropaper | Execute o AstroPaper no Docker. O site estará acessível em http://localhost:4321 . |
Aviso! Os usuários do Windows PowerShell podem precisar instalar o pacote simultaneamente se quiserem executar diagnósticos durante o desenvolvimento (
astro check --watch & astro dev
). Para obter mais informações, consulte este problema.
Se você tiver alguma sugestão/feedback, pode entrar em contato comigo através do meu e-mail. Alternativamente, sinta-se à vontade para abrir um problema se encontrar bugs ou desejar solicitar novos recursos.
Licenciado sob a licença MIT, Copyright © 2023
Feito com? por Sat Naing ?? e colaboradores.