Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: udpate readme #107

Merged
merged 2 commits into from
Jan 3, 2024
Merged

chore: udpate readme #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bd5b94
chore: udpate readme
alberto-abarzua Jan 3, 2024
fcf6b64
chore: update deps
alberto-abarzua Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
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)
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"autoprefixer": "^10.4.16",
"bootstrap": "^5.3.2",
"clipboard": "^2.0",
"eslint": "^8.55.0",
"eslint": "^8.56.0",
"exec-bin": "^1.0.0",
"flexsearch": "^0.7.31",
"highlight.js": "^11.9",
Expand All @@ -62,9 +62,9 @@
"postcss-cli": "^11.0",
"purgecss-whitelister": "^2.4",
"shx": "^0.3.4",
"stylelint": "^16.0",
"stylelint": "^16.1",
"stylelint-config-standard-scss": "^12.0",
"tailwindcss": "^3.3.6"
"tailwindcss": "^3.4.0"
},
"otherDependencies": {
"hugo": "0.107.0"
Expand Down
Loading