Skip to content

Commit 542e985

Browse files
committed
Eliminar PLAN.md y actualizar README con documentación completa
1 parent 02d6374 commit 542e985

File tree

2 files changed

+79
-240
lines changed

2 files changed

+79
-240
lines changed

PLAN.md

Lines changed: 0 additions & 222 deletions
This file was deleted.

README.md

Lines changed: 79 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,102 @@
1-
# Website
1+
# Código Sin Siesta
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
Sitio web principal de la organización **Código Sin Siesta** - Documentación técnica, blog de desarrollo y recursos para la comunidad.
44

5-
## Installation
5+
🌐 **Sitio en vivo:** [https://codigosinsiesta.github.io/](https://codigosinsiesta.github.io/)
6+
7+
## Tecnología
8+
9+
Este sitio está construido con [Docusaurus 3](https://docusaurus.io/), un generador de sitios estáticos moderno que ofrece:
10+
11+
- 🚀 Renderizado optimizado y carga rápida
12+
- 📱 Diseño responsive y modo oscuro
13+
- 🔍 Búsqueda integrada
14+
- 📝 Soporte para MDX (Markdown + React)
15+
- 🌐 Internacionalización (i18n)
16+
17+
## Desarrollo Local
18+
19+
### Requisitos Previos
20+
21+
- Node.js 20 o superior
22+
- pnpm (recomendado) o npm/yarn
23+
24+
### Instalación
625

726
```bash
8-
yarn
27+
pnpm install
928
```
1029

11-
## Local Development
30+
### Servidor de Desarrollo
1231

1332
```bash
14-
yarn start
33+
pnpm start
1534
```
1635

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
36+
Esto inicia un servidor local en `http://localhost:3000` con recarga automática.
1837

19-
## Build
38+
### Build de Producción
2039

2140
```bash
22-
yarn build
41+
pnpm build
2342
```
2443

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
44+
Genera el contenido estático en el directorio `build/`.
2645

27-
## Deployment
28-
29-
Using SSH:
46+
### Previsualizar Build
3047

3148
```bash
32-
USE_SSH=true yarn deploy
49+
pnpm serve
3350
```
3451

35-
Not using SSH:
52+
Sirve el contenido del directorio `build/` para previsualizar antes de desplegar.
3653

37-
```bash
38-
GIT_USER=<Your GitHub username> yarn deploy
54+
## Deployment
55+
56+
El sitio se despliega automáticamente a GitHub Pages mediante GitHub Actions cuando se hace push a la rama `main`.
57+
58+
### Workflow de Deploy
59+
60+
El archivo `.github/workflows/deploy.yml` maneja el proceso de deployment:
61+
62+
1. Checkout del código
63+
2. Configuración de pnpm y Node.js 20
64+
3. Instalación de dependencias
65+
4. Build del sitio
66+
5. Deploy a GitHub Pages
67+
68+
## Estructura del Proyecto
69+
70+
```
71+
codigosinsiesta.github.io/
72+
├── blog/ # Posts del blog
73+
├── docs/ # Documentación técnica
74+
├── src/
75+
│ ├── components/ # Componentes React personalizados
76+
│ ├── css/ # Estilos globales
77+
│ └── pages/ # Páginas estáticas
78+
├── static/ # Archivos estáticos (imágenes, favicon, etc.)
79+
├── docusaurus.config.js # Configuración principal
80+
└── sidebars.js # Configuración de sidebars
3981
```
4082

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
83+
## Contribuir
84+
85+
Para contribuir al sitio:
86+
87+
1. Crea una rama desde `main`
88+
2. Realiza tus cambios
89+
3. Crea un Pull Request
90+
4. Espera la aprobación y merge
91+
92+
**Nota:** La rama `main` está protegida y requiere revisión de Pull Request.
93+
94+
## Enlaces
95+
96+
- [Organización GitHub](https://github.com/codigosinsiesta)
97+
- [Proyecto AI Presentation](https://codigosinsiesta.github.io/ai-presentation/)
98+
- [Documentación Docusaurus](https://docusaurus.io/)
99+
100+
## Licencia
101+
102+
Copyright © 2025 Código Sin Siesta. Built with Docusaurus.

0 commit comments

Comments
 (0)