Skip to content

Commit

Permalink
chore: udpate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alberto-abarzua committed Jan 3, 2024
1 parent 9283d94 commit 0ff51fc
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@

2. Usar docker y correr 'docker compose up' para correr el sitio localmente. **Recomendado**


## Como hacer deploy

El deploy se realiza automaticamente al hacer un commit a la rama `main`, esto se hace a travez de un Github Action a Github Pages.

Al hacer el pull request y subir commits se correran los tests (linting de md), para poder merigar se deben de pasar todos los tests.

## Como editar el contenido

La gran mayoria del contenido se escribe simplemente en formato Markdown, esto se encuentra en el directorio de `/content`.
Expand All @@ -18,6 +21,12 @@ La gran mayoria del contenido se escribe simplemente en formato Markdown, esto s

Se puede agregar una pagina nueva corriendo el siguiente comando:

En caso de hacerlo bajo docker, primero abrir un shell en el contenedor con:

```bash
docker compose run site /bin/sh
```

```bash
npm run create path/to/new/page
```
Expand All @@ -42,6 +51,6 @@ docker compose run site npm run create path/to/new/page

Se pueden revisar los ejemplos de las paginas ya existentes para ver como se escribe el contenido.

**Nota:**
**Nota:**
- Si se agrega una nueva seccion o pagina revisar en los headers de cada pagina que el `weight` este bien definido, esto es para que se mantenga el orden de las paginas.
- Cambiar `draft: true` a `draft: false` en el header de la pagina para que se publique y se pueda ver. (por defecto esta en `true` para que no se publique hasta que este listo)

0 comments on commit 0ff51fc

Please sign in to comment.