Skip to content

Commit

Permalink
Merge pull request #5 from JaquerEspeis/4-traducir-como-colaborar
Browse files Browse the repository at this point in the history
4 traducir como colaborar
  • Loading branch information
rngkll authored Oct 14, 2024
2 parents 1b20e6c + 8cc5efc commit 5218c41
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ jobs:
key: ${{ github.ref }}
path: .cache
- run: cd mkdocs
- run: pip -r requirements.txt
- run: pip install -r requirements.txt
- run: mkdocs gh-deploy --force
24 changes: 12 additions & 12 deletions mkdocs/docs/howto/ComoColaborar.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# How to contribute to this documentation
# Cómo contribuir a esta documentación

> The main documentation of the SCOOP project.
> La documentación principal del Libre DataCenter.
Deployed at https://carbon-offset-open-platform.github.io/mainPublicDoc.
Desplegado en https://jaquerespeis.github.io/libreDataCenter/

## Contribute
## Contribuir

### Setting up
### Configurar ambiente
```
git clone git@github.com:Carbon-Offset-Open-Platform/mainPublicDoc.git
python3 -m venv venv
source venv/bin/activate
(venv) ~ pip install mkdocs-material
```

### Add content
1. Create a `.md` file in the respective folder and write your content in Markdown formatting. [Learn more here.](https://www.markdownguide.org/).
1. Edit `mkdocs.yml` and add your file to the `nav` section.
1. Commit and sync your GIT repo.
### Añadir contenido
1. Crea un archivo `.md` en la carpeta respectiva y escribe tu contenido utilizando formato Markdown. [Aprende más aquí.](https://www.markdownguide.org/).
1. Edita `mkdocs.yml` y agrega tu archivo a la sección `nav`.
1. Realiza un commit y sincroniza tu repositorio GIT.

### Test and Build
### Probar y construir

After getting into the Python environment either run serve to see the results locally in your web browser:
Después de ingresar al entorno de Python, puedes ejecutar `serve` para ver los resultados localmente en tu navegador web:
```
source venv/bin/activate
(venv) ~ pip install mkdocs-material
mkdocs serve
```

Or when everything is done, run build to create the static website:
O, cuando todo esté listo, ejecuta `build` para crear el sitio web estático:
```
mkdoc build
```
Expand Down
4 changes: 2 additions & 2 deletions mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ theme:
nav:
- Home: 'index.md'
- Pasos:
- Lista de materiales: 'docs/pasos/ListaDeMateriales.md'
- Lista de materiales: 'pasos/ListaDeMateriales.md'
- HowTos:
- Colaborar: 'docs/howto/ComoColaborar.md'
- Colaborar: 'howto/ComoColaborar.md'

markdown_extensions:
- def_list
Expand Down

0 comments on commit 5218c41

Please sign in to comment.