create-openclass-uniminuto 1.4.0 → 1.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "create-openclass-uniminuto",
3
- "version": "1.4.0",
3
+ "version": "1.4.2",
4
4
  "description": "Creador de proyectos Open Class UNIMINUTO basados en Slidev, con generación incremental por semanas y GitHub Pages.",
5
5
  "type": "module",
6
6
  "bin": {
7
- "create-openclass-uniminuto": "./bin/create-openclass-uniminuto.mjs"
7
+ "create-openclass-uniminuto": "bin/create-openclass-uniminuto.mjs"
8
8
  },
9
9
  "files": [
10
10
  "bin",
@@ -1,326 +1,326 @@
1
- # Open Class UNIMINUTO · Slidev
2
-
3
- Proyecto generado con `create-openclass-uniminuto` o creado desde la plantilla `openclass-uniminuto-template`.
4
-
5
- Este curso está diseñado para organizar una Open Class de **8 semanas**, con generación progresiva de cada semana, portal principal, lanzadores individuales, exportación de PDF/PPTX y publicación automática en **GitHub Pages**.
6
-
7
- ---
8
-
9
-
10
- ## Crear el curso dentro de un repositorio ya creado en GitHub
11
-
12
- Si primero creaste el repositorio en GitHub, clónalo y aplica la plantilla desde npm dentro de la carpeta del repositorio:
13
-
14
- ```bash
15
- git clone https://github.com/herrerawilliamh/openclass-iot.git
16
- cd openclass-iot
17
- npm create openclass-uniminuto@latest . -- --iot
18
- npm install
19
- npm run semana -- 1
20
- npm run dev
21
- ```
22
-
23
- Si el repositorio ya tenía archivos iniciales y deseas reemplazarlos por los de la plantilla:
24
-
25
- ```bash
26
- npm create openclass-uniminuto@latest . -- --iot --force
27
- ```
28
-
29
- La sincronización con GitHub se hace después con Git:
30
-
31
- ```bash
32
- git add -A
33
- git commit -m "Configura Open Class"
34
- git push
35
- ```
36
-
37
-
38
- ## 1. Primer uso
39
-
40
- Instala dependencias:
41
-
42
- ```bash
43
- npm install
44
- ```
45
-
46
- Configura el curso desde consola:
47
-
48
- ```bash
49
- npm run nuevo
50
- ```
51
-
52
- Genera la primera semana:
53
-
54
- ```bash
55
- npm run semana -- 1
56
- ```
57
-
58
- Ejecuta el portal principal:
59
-
60
- ```bash
61
- npm run dev
62
- ```
63
-
64
- Una semana específica se abre con:
65
-
66
- ```bash
67
- npm run dev:s1
68
- npm run dev:s2
69
- npm run dev:s3
70
- ```
71
-
72
- ---
73
-
74
- ## 2. Tres formas de crear este curso
75
-
76
- ### Opción A · Desde npm
77
-
78
- ```bash
79
- npm create openclass-uniminuto@latest openclass-iot -- --iot
80
- cd openclass-iot
81
- npm install
82
- npm run semana -- 1
83
- npm run dev
84
- ```
85
-
86
- ### Opción B · Desde GitHub Template
87
-
88
- 1. Entra al repositorio `openclass-uniminuto-template`.
89
- 2. Clic en **Use this template**.
90
- 3. Crea un repositorio nuevo, por ejemplo `openclass-iot`.
91
- 4. Clónalo.
92
- 5. Ejecuta los comandos del curso.
93
-
94
- ```bash
95
- git clone https://github.com/herrerawilliamh/openclass-iot.git
96
- cd openclass-iot
97
- npm install
98
- npm run nuevo
99
- npm run semana -- 1
100
- npm run dev
101
- ```
102
-
103
- ### Opción C · Repo creado en GitHub y curso generado en local
104
-
105
- Esta opción combina GitHub y npm.
106
-
107
- #### Si el repositorio fue creado desde plantilla
108
-
109
- ```bash
110
- git clone https://github.com/herrerawilliamh/openclass-iot.git
111
- cd openclass-iot
112
- npm install
113
- npm run nuevo
114
- npm run semana -- 1
115
- npm run dev
116
- ```
117
-
118
- Luego:
119
-
120
- ```bash
121
- git add -A
122
- git commit -m "Generar semana 1"
123
- git push
124
- ```
125
-
126
- #### Si el repositorio está vacío
127
-
128
- ```bash
129
- npm create openclass-uniminuto@latest openclass-iot -- --iot
130
- cd openclass-iot
131
- npm install
132
- npm run semana -- 1
133
- npm run dev
134
- ```
135
-
136
- Después conecta el remoto:
137
-
138
- ```bash
139
- git init
140
- git branch -M main
141
- git add -A
142
- git commit -m "Publicación inicial Open Class"
143
- git remote add origin https://github.com/herrerawilliamh/openclass-iot.git
144
- git push -u origin main
145
- ```
146
-
147
- ---
148
-
149
- ## 3. Generar semanas una a una
150
-
151
- El curso siempre se organiza en **8 semanas**. Puedes generarlas progresivamente.
152
-
153
- ```bash
154
- npm run semana -- 1
155
- npm run semana -- 2 --title "Título de la semana 2" --date "Junio 15 de 2026"
156
- npm run semana -- 3 --title "Título de la semana 3" --theme "Tema central"
157
- ```
158
-
159
- El comando `semana` actualiza automáticamente:
160
-
161
- ```text
162
- openclass.config.json
163
- slides.md
164
- scripts/decks.mjs
165
- package.json
166
- curso_semanaN.md
167
- semanas/curso_semanaN.md
168
- ```
169
-
170
- El contenido ya editado dentro de `semanas/*.md` se conserva. Solo se sobrescribe si usas:
171
-
172
- ```bash
173
- npm run semana -- 4 --force-content
174
- ```
175
-
176
- Para activar únicamente una semana:
177
-
178
- ```bash
179
- npm run semana -- 4 --only
180
- ```
181
-
182
- ---
183
-
184
- ## 4. Editar contenido académico
185
-
186
- El contenido real de cada presentación está en:
187
-
188
- ```text
189
- semanas/
190
- ```
191
-
192
- Ejemplo:
193
-
194
- ```text
195
- semanas/iot_semana1.md
196
- semanas/iot_semana2.md
197
- semanas/iot_semana3.md
198
- ```
199
-
200
- Los archivos de la raíz como `iot_semana1.md` funcionan como lanzadores. Normalmente no debes editarlos manualmente.
201
-
202
- ---
203
-
204
- ## 5. Recursos del curso
205
-
206
- Usa estas carpetas:
207
-
208
- ```text
209
- public/imagenes/ imágenes del curso
210
- public/videos/ videos y recursos audiovisuales
211
- public/descargas/ PDF, PPTX u otros descargables
212
- public/fondos/ fondos institucionales
213
- ```
214
-
215
- ---
216
-
217
- ## 6. Construcción local
218
-
219
- Construir el portal y las semanas activas:
220
-
221
- ```bash
222
- npm run pages:build
223
- ```
224
-
225
- Previsualizar la versión estática:
226
-
227
- ```bash
228
- npm run pages:preview
229
- ```
230
-
231
- Revisar configuración para GitHub Pages:
232
-
233
- ```bash
234
- npm run pages:check
235
- ```
236
-
237
- ---
238
-
239
- ## 7. Publicar en GitHub Pages
240
-
241
- Este proyecto ya incluye:
242
-
243
- ```text
244
- .github/workflows/deploy.yml
245
- ```
246
-
247
- El workflow construye el sitio y publica la carpeta `dist` en GitHub Pages.
248
-
249
- En GitHub configura:
250
-
251
- ```text
252
- Settings → Pages → Build and deployment → Source → GitHub Actions
253
- ```
254
-
255
- Luego sube cambios:
256
-
257
- ```bash
258
- git add -A
259
- git commit -m "Actualizar Open Class"
260
- git push
261
- ```
262
-
263
- Cada `push` a `main` construirá y publicará el sitio automáticamente.
264
-
265
- La URL esperada será:
266
-
267
- ```text
268
- https://herrerawilliamh.github.io/NOMBRE-DEL-REPOSITORIO/
269
- ```
270
-
271
- Ejemplo:
272
-
273
- ```text
274
- https://herrerawilliamh.github.io/openclass-iot/
275
- ```
276
-
277
- ---
278
-
279
- ## 8. Flujo semanal sugerido
280
-
281
- Semana 1:
282
-
283
- ```bash
284
- npm run semana -- 1 --title "Introducción al curso"
285
- git add -A
286
- git commit -m "Agregar semana 1"
287
- git push
288
- ```
289
-
290
- Semana 2:
291
-
292
- ```bash
293
- npm run semana -- 2 --title "Tema de la semana 2"
294
- git add -A
295
- git commit -m "Agregar semana 2"
296
- git push
297
- ```
298
-
299
- Repite el proceso hasta la semana 8.
300
-
301
- ---
302
-
303
- ## 9. Comandos útiles
304
-
305
- | Comando | Uso |
306
- |---|---|
307
- | `npm run nuevo` | Configura un curso desde consola |
308
- | `npm run semana -- 1` | Genera o activa la semana 1 |
309
- | `npm run dev` | Abre el portal principal |
310
- | `npm run dev:s1` | Abre la semana 1 |
311
- | `npm run pages:check` | Revisa configuración para GitHub Pages |
312
- | `npm run pages:build` | Construye el sitio estático y exporta descargas |
313
- | `npm run pages:preview` | Previsualiza la versión publicada |
314
- | `npm run publicar` | Ejecuta exportaciones y construcción local |
315
-
316
- ---
317
-
318
- ## 10. Archivos clave
319
-
320
- ```text
321
- openclass.config.json configuración general del curso
322
- slides.md portal principal
323
- semanas/ contenido académico real
324
- scripts/decks.mjs listado de presentaciones activas
325
- .github/workflows/deploy.yml despliegue automático en GitHub Pages
326
- ```
1
+ # Open Class UNIMINUTO · Slidev
2
+
3
+ Proyecto generado con `create-openclass-uniminuto` o creado desde la plantilla `openclass-uniminuto-template`.
4
+
5
+ Este curso está diseñado para organizar una Open Class de **8 semanas**, con generación progresiva de cada semana, portal principal, lanzadores individuales, exportación de PDF/PPTX y publicación automática en **GitHub Pages**.
6
+
7
+ ---
8
+
9
+
10
+ ## Crear el curso dentro de un repositorio ya creado en GitHub
11
+
12
+ Si primero creaste el repositorio en GitHub, clónalo y aplica la plantilla desde npm dentro de la carpeta del repositorio:
13
+
14
+ ```bash
15
+ git clone https://github.com/herrerawilliamh/openclass-iot.git
16
+ cd openclass-iot
17
+ npm create openclass-uniminuto@latest . -- --iot
18
+ npm install
19
+ npm run semana -- 1
20
+ npm run dev
21
+ ```
22
+
23
+ Si el repositorio ya tenía archivos iniciales y deseas reemplazarlos por los de la plantilla:
24
+
25
+ ```bash
26
+ npm create openclass-uniminuto@latest . -- --iot --force
27
+ ```
28
+
29
+ La sincronización con GitHub se hace después con Git:
30
+
31
+ ```bash
32
+ git add -A
33
+ git commit -m "Configura Open Class"
34
+ git push
35
+ ```
36
+
37
+
38
+ ## 1. Primer uso
39
+
40
+ Instala dependencias:
41
+
42
+ ```bash
43
+ npm install
44
+ ```
45
+
46
+ Configura el curso desde consola:
47
+
48
+ ```bash
49
+ npm run nuevo
50
+ ```
51
+
52
+ Genera la primera semana:
53
+
54
+ ```bash
55
+ npm run semana -- 1
56
+ ```
57
+
58
+ Ejecuta el portal principal:
59
+
60
+ ```bash
61
+ npm run dev
62
+ ```
63
+
64
+ Una semana específica se abre con:
65
+
66
+ ```bash
67
+ npm run dev:s1
68
+ npm run dev:s2
69
+ npm run dev:s3
70
+ ```
71
+
72
+ ---
73
+
74
+ ## 2. Tres formas de crear este curso
75
+
76
+ ### Opción A · Desde npm
77
+
78
+ ```bash
79
+ npm create openclass-uniminuto@latest openclass-iot -- --iot
80
+ cd openclass-iot
81
+ npm install
82
+ npm run semana -- 1
83
+ npm run dev
84
+ ```
85
+
86
+ ### Opción B · Desde GitHub Template
87
+
88
+ 1. Entra al repositorio `openclass-uniminuto-template`.
89
+ 2. Clic en **Use this template**.
90
+ 3. Crea un repositorio nuevo, por ejemplo `openclass-iot`.
91
+ 4. Clónalo.
92
+ 5. Ejecuta los comandos del curso.
93
+
94
+ ```bash
95
+ git clone https://github.com/herrerawilliamh/openclass-iot.git
96
+ cd openclass-iot
97
+ npm install
98
+ npm run nuevo
99
+ npm run semana -- 1
100
+ npm run dev
101
+ ```
102
+
103
+ ### Opción C · Repo creado en GitHub y curso generado en local
104
+
105
+ Esta opción combina GitHub y npm.
106
+
107
+ #### Si el repositorio fue creado desde plantilla
108
+
109
+ ```bash
110
+ git clone https://github.com/herrerawilliamh/openclass-iot.git
111
+ cd openclass-iot
112
+ npm install
113
+ npm run nuevo
114
+ npm run semana -- 1
115
+ npm run dev
116
+ ```
117
+
118
+ Luego:
119
+
120
+ ```bash
121
+ git add -A
122
+ git commit -m "Generar semana 1"
123
+ git push
124
+ ```
125
+
126
+ #### Si el repositorio está vacío
127
+
128
+ ```bash
129
+ npm create openclass-uniminuto@latest openclass-iot -- --iot
130
+ cd openclass-iot
131
+ npm install
132
+ npm run semana -- 1
133
+ npm run dev
134
+ ```
135
+
136
+ Después conecta el remoto:
137
+
138
+ ```bash
139
+ git init
140
+ git branch -M main
141
+ git add -A
142
+ git commit -m "Publicación inicial Open Class"
143
+ git remote add origin https://github.com/herrerawilliamh/openclass-iot.git
144
+ git push -u origin main
145
+ ```
146
+
147
+ ---
148
+
149
+ ## 3. Generar semanas una a una
150
+
151
+ El curso siempre se organiza en **8 semanas**. Puedes generarlas progresivamente.
152
+
153
+ ```bash
154
+ npm run semana -- 1
155
+ npm run semana -- 2 --title "Título de la semana 2" --date "Junio 15 de 2026"
156
+ npm run semana -- 3 --title "Título de la semana 3" --theme "Tema central"
157
+ ```
158
+
159
+ El comando `semana` actualiza automáticamente:
160
+
161
+ ```text
162
+ openclass.config.json
163
+ slides.md
164
+ scripts/decks.mjs
165
+ package.json
166
+ curso_semanaN.md
167
+ semanas/curso_semanaN.md
168
+ ```
169
+
170
+ El contenido ya editado dentro de `semanas/*.md` se conserva. Solo se sobrescribe si usas:
171
+
172
+ ```bash
173
+ npm run semana -- 4 --force-content
174
+ ```
175
+
176
+ Para activar únicamente una semana:
177
+
178
+ ```bash
179
+ npm run semana -- 4 --only
180
+ ```
181
+
182
+ ---
183
+
184
+ ## 4. Editar contenido académico
185
+
186
+ El contenido real de cada presentación está en:
187
+
188
+ ```text
189
+ semanas/
190
+ ```
191
+
192
+ Ejemplo:
193
+
194
+ ```text
195
+ semanas/iot_semana1.md
196
+ semanas/iot_semana2.md
197
+ semanas/iot_semana3.md
198
+ ```
199
+
200
+ Los archivos de la raíz como `iot_semana1.md` funcionan como lanzadores. Normalmente no debes editarlos manualmente.
201
+
202
+ ---
203
+
204
+ ## 5. Recursos del curso
205
+
206
+ Usa estas carpetas:
207
+
208
+ ```text
209
+ public/imagenes/ imágenes del curso
210
+ public/videos/ videos y recursos audiovisuales
211
+ public/descargas/ PDF, PPTX u otros descargables
212
+ public/fondos/ fondos institucionales
213
+ ```
214
+
215
+ ---
216
+
217
+ ## 6. Construcción local
218
+
219
+ Construir el portal y las semanas activas:
220
+
221
+ ```bash
222
+ npm run pages:build
223
+ ```
224
+
225
+ Previsualizar la versión estática:
226
+
227
+ ```bash
228
+ npm run pages:preview
229
+ ```
230
+
231
+ Revisar configuración para GitHub Pages:
232
+
233
+ ```bash
234
+ npm run pages:check
235
+ ```
236
+
237
+ ---
238
+
239
+ ## 7. Publicar en GitHub Pages
240
+
241
+ Este proyecto ya incluye:
242
+
243
+ ```text
244
+ .github/workflows/deploy.yml
245
+ ```
246
+
247
+ El workflow construye el sitio y publica la carpeta `dist` en GitHub Pages.
248
+
249
+ En GitHub configura:
250
+
251
+ ```text
252
+ Settings → Pages → Build and deployment → Source → GitHub Actions
253
+ ```
254
+
255
+ Luego sube cambios:
256
+
257
+ ```bash
258
+ git add -A
259
+ git commit -m "Actualizar Open Class"
260
+ git push
261
+ ```
262
+
263
+ Cada `push` a `main` construirá y publicará el sitio automáticamente.
264
+
265
+ La URL esperada será:
266
+
267
+ ```text
268
+ https://herrerawilliamh.github.io/NOMBRE-DEL-REPOSITORIO/
269
+ ```
270
+
271
+ Ejemplo:
272
+
273
+ ```text
274
+ https://herrerawilliamh.github.io/openclass-iot/
275
+ ```
276
+
277
+ ---
278
+
279
+ ## 8. Flujo semanal sugerido
280
+
281
+ Semana 1:
282
+
283
+ ```bash
284
+ npm run semana -- 1 --title "Introducción al curso"
285
+ git add -A
286
+ git commit -m "Agregar semana 1"
287
+ git push
288
+ ```
289
+
290
+ Semana 2:
291
+
292
+ ```bash
293
+ npm run semana -- 2 --title "Tema de la semana 2"
294
+ git add -A
295
+ git commit -m "Agregar semana 2"
296
+ git push
297
+ ```
298
+
299
+ Repite el proceso hasta la semana 8.
300
+
301
+ ---
302
+
303
+ ## 9. Comandos útiles
304
+
305
+ | Comando | Uso |
306
+ |---|---|
307
+ | `npm run nuevo` | Configura un curso desde consola |
308
+ | `npm run semana -- 1` | Genera o activa la semana 1 |
309
+ | `npm run dev` | Abre el portal principal |
310
+ | `npm run dev:s1` | Abre la semana 1 |
311
+ | `npm run pages:check` | Revisa configuración para GitHub Pages |
312
+ | `npm run pages:build` | Construye el sitio estático y exporta descargas |
313
+ | `npm run pages:preview` | Previsualiza la versión publicada |
314
+ | `npm run publicar` | Ejecuta exportaciones y construcción local |
315
+
316
+ ---
317
+
318
+ ## 10. Archivos clave
319
+
320
+ ```text
321
+ openclass.config.json configuración general del curso
322
+ slides.md portal principal
323
+ semanas/ contenido académico real
324
+ scripts/decks.mjs listado de presentaciones activas
325
+ .github/workflows/deploy.yml despliegue automático en GitHub Pages
326
+ ```