ArchiHUB es una plataforma de documentación y recursos para arquitectos y profesionales del diseño. Este repositorio contiene el código fuente del sitio web de documentación de ArchiHUB.
- Node.js - v18.17.1 o superior (excepto v19)
- Editor de código - Recomendamos VS Code con la extensión oficial de Astro
- Terminal - Astro se utiliza a través de la interfaz de línea de comandos (CLI)
- Clona el repositorio:
git clone https://github.com/ArchiHUB-App/archihub.github.io
- Navega a la carpeta del proyecto:
cd archihub-docs - Instala las dependencias:
npm install
- Inicia el servidor de desarrollo:
Tu sitio estará disponible en
npm run dev
http://localhost:4321.
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ │ ├── en/
│ │ │ ├── es/
│ │ │ └── index.mdx
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
| Comando | Acción |
|---|---|
npm install |
Instala las dependencias |
npm run dev |
Inicia el servidor de desarrollo en localhost:4321 |
npm run build |
Construye el sitio para producción en ./dist/ |
npm run preview |
Previsualiza la versión de producción localmente |
Para agregar o modificar contenido de la documentación:
- Crea o edita archivos Markdown (.md) en la carpeta
src/content/docs/[es/en]. Por el momento la documentación está en español e inglés, por lo que se deben editar los archivos Markdown correspondientes en cada idioma. - Utiliza la sintaxis de Markdown para formatear el contenido.
- Agrega imágenes en la carpeta
public/images/y refiérete a ellas usando rutas relativas.
El sitio se despliega automáticamente en GitHub Pages cuando se hace push a la rama principal. Para desplegar manualmente:
- Construye el sitio:
npm run build
- El resultado estará en la carpeta
./dist/, listo para ser subido a un servicio de hosting estático.
Las contribuciones son bienvenidas. Por favor, abre un issue o un pull request para sugerir cambios o mejoras.
Este proyecto está bajo la licencia MIT. Consulta el archivo LICENSE para más detalles.