web-ansol.org/README.md

51 lines
1.8 KiB
Markdown
Raw Normal View History

2023-01-15 18:30:19 +00:00
# Como contribuir para o sítio Web da ANSOL
## Novo evento para a agenda:
2023-03-23 21:07:20 +00:00
Os eventos são adicionados à agenda criando um novo ficheiro em formato
markdown [content/eventos/](./content/eventos). Pode ser adicionado um ficheiro
que servirá de ícone na lista dos eventos, idealmente no formato svg.
2023-01-15 18:50:55 +00:00
2023-01-15 19:14:44 +00:00
### Instruções
2023-01-15 18:50:55 +00:00
2023-03-23 21:07:20 +00:00
1. criar uma directoria em `content/eventos/`, dedicada ao evento (por exemplo "content/eventos/AAAA-MM-DD-megahackaton").
2023-01-15 19:14:44 +00:00
2. na sub-directoria de evento deverá ser criado um ficheiro chamado index.md, com o conteúdo como este template de exemplo:
2023-03-23 21:07:20 +00:00
```
---
layout: evento
title: Nome do evento
metadata:
event:
location: Local Mega fixe, Rua super-cool, nº 1 2A, 9999-999 Cidade
site:
url: https://website.do.evento.org/
date:
start: AAAA-MM-DD
finish: AAAA-MM-DD
---
Descrição textual do evento, possivelmente com outras imagens (que devem ser
adicionadas à mesma directoria deste ficheiro), como por exemplo uma imagem de cartaz:
![Cartaz](cartaz.png)
```
3. caso haja uma imagem de ícone para o evento, esta deve ser colocada na directoria do evento e ter o nome `cover` (por exemplo: cover.svg, ou cover.png).
2023-01-15 19:14:44 +00:00
2023-01-15 19:17:17 +00:00
Exemplo de layout de ficheiros para um evento na agenda:
2023-01-15 19:14:44 +00:00
```
content/eventos/
2023-03-23 21:07:20 +00:00
2024-01-01-megahackaton/
cartaz.png
2023-01-15 19:14:44 +00:00
cover.svg
2023-03-23 21:07:20 +00:00
index.md
2023-01-15 19:14:44 +00:00
```
2023-01-15 18:30:19 +00:00
2023-03-23 21:07:20 +00:00
**Atenção**: não é recomendado utilizar imagens de cartaz como "cover", porque
irá aparecer num quadrado pequeno na lista de eventos. Quando houver imagens de cartaz,
o ideal é adicionar o cartaz à directoria e incluí-la na descrição do evento, em markdown.
2023-01-15 18:30:19 +00:00
# Licença
2023-01-28 13:06:38 +00:00
Como podem ver no ficheiro [LICENSE](./LICENSE), o sítio Web da ANSOL está licenciado com a licença GNU Affero General Public License Version 3 (AGPLv3).