Dentro de AstroPaper, verá las siguientes carpetas y archivos:
/
├── 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
Astro busca archivos .astro
o .md
en el directorio src/pages/
. Cada página se expone como una ruta según su nombre de archivo.
Cualquier recurso estático, como imágenes, se puede colocar en el directorio public/
.
Todas las publicaciones del blog se almacenan en el directorio src/content/blog
.
La documentación se puede leer en dos formatos: rebajas y publicaciones de blog .
Para AstroPaper v1, consulte esta rama y esta URL activa
Marco principal - Astro
Comprobación de tipos : TypeScript
Marco de componentes - ReactJS
Estilo - TailwindCSS
UI/UX - Archivo de diseño Figma
Búsqueda difusa - FuseJS
Iconos - Cajas | mesas
Formato de código : más bonito
Implementación : páginas de Cloudflare
Ilustración en la página Acerca de: https://freesvgIllustration.com
Linting - ESLint
Puede comenzar a usar este proyecto localmente ejecutando el siguiente comando en el directorio que desee:
# 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
¡Advertencia! Si estás usando
yarn 1
, es posible que necesites instalarsharp
como dependencia.
Luego inicie el proyecto ejecutando los siguientes comandos:
# install dependencies
npm run install
# start running the project
npm run dev
Como método alternativo, si tiene Docker instalado, puede utilizar Docker para ejecutar este proyecto localmente. He aquí cómo:
# Build the Docker image
docker build -t astropaper .
# Run the Docker container
docker run -p 4321:80 astropaper
Puede agregar fácilmente su etiqueta HTML de verificación del sitio de Google en AstroPaper utilizando una variable de entorno. Este paso es opcional. Si no agrega la siguiente variable de entorno, la etiqueta google-site-verification no aparecerá en la sección HTML <head>
.
# in your environment variable file (.env)
PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value
Consulte esta discusión para agregar AstroPaper a Google Search Console.
Todos los comandos se ejecutan desde la raíz del proyecto, desde una terminal:
¡Nota! Para los comandos
Docker
debemos tenerlo instalado en nuestra máquina.
Dominio | Acción |
---|---|
npm install | Instala dependencias |
npm run dev | Inicia el servidor de desarrollo local en localhost:4321 |
npm run build | Construya su sitio de producción en ./dist/ |
npm run preview | Obtenga una vista previa de su compilación localmente, antes de implementarla |
npm run format:check | Verificar formato de código con Prettier |
npm run format | Formatear códigos con Prettier |
npm run sync | Genera tipos de TypeScript para todos los módulos de Astro. Obtenga más información. |
npm run lint | Pelusa con ESLint |
docker compose up -d | Ejecute AstroPaper en la ventana acoplable. Puede acceder con el mismo nombre de host y puerto informado en el comando dev . |
docker compose run app npm install | Puede ejecutar cualquier comando anterior en el contenedor de la ventana acoplable. |
docker build -t astropaper . | Cree una imagen de Docker para AstroPaper. |
docker run -p 4321:80 astropaper | Ejecute AstroPaper en Docker. Se podrá acceder al sitio web en http://localhost:4321 . |
¡Advertencia! Es posible que los usuarios de Windows PowerShell necesiten instalar el paquete simultáneamente si desean ejecutar diagnósticos durante el desarrollo (
astro check --watch & astro dev
). Para obtener más información, consulte este número.
Si tiene alguna sugerencia/comentario, puede contactarme a través de mi correo electrónico. Alternativamente, no dude en abrir un problema si encuentra errores o desea solicitar nuevas funciones.
Licenciado bajo la licencia MIT, Copyright © 2023
Hecho con ? por Sat Naing ?? y colaboradores.