mirror of
https://gitlab.com/ansol/web-ansol.org.git
synced 2024-12-24 12:55:44 +00:00
Update file Readme.md
This commit is contained in:
parent
8acc053dfe
commit
901b1cf23e
29
Readme.md
29
Readme.md
@ -4,14 +4,10 @@
|
||||
|
||||
Os eventos são adicionados à agenda criando um novo ficheiro em em formato markdown [content/eventos/](./content/eventos). Adicionalmente pode ser adicionado um ficheiro com uma imagem para "cover", idealmente no formato svg.
|
||||
|
||||
### Requisitos para o ficheiro markdown para o evento
|
||||
### Instruções
|
||||
|
||||
O ficheiro de markdown para o evento deverá cumprir aos seguintes requisitos:
|
||||
|
||||
1. estar localizado em `content/eventos/` (relativo à raiz do projecto), ou em uma sub-directoria dentro deste caminho (por exemplo "content/eventos/AAAA-MM-DD-megahackaton").
|
||||
2. ter o nome de acordo com o seguinte formato:
|
||||
`AAAA-MM-DD-nome-do-evento.md`; ou no caso de estar dentro de uma subdirectoria, o nome desta deve assumir o formato `AAAA-MM-DD-nome-do-evento` e o ficheiro de markdown deve ter o nome `index.md`
|
||||
3. o conteúdo do ficheiro de markdown do evento deverá cumprir o seguinte formato:
|
||||
1. criar umas directoria em `content/eventos/`, dedicada ao evento (por exemplo "content/eventos/AAAA-MM-DD-megahackaton").
|
||||
2. na sub-directoria de evento deverá ser criado um ficheiro chamado index.md, com o conteúdo como este template de exemplo:
|
||||
```
|
||||
---
|
||||
layout: evento
|
||||
@ -22,11 +18,24 @@ metadata:
|
||||
site:
|
||||
url: https://website.do.evento.org/
|
||||
date:
|
||||
start: AAAA-MM-DD HH:MM
|
||||
finish: AAAA-MM-DD HH:MM
|
||||
start: AAAA-MM-DD
|
||||
finish: AAAA-MM-DD
|
||||
---
|
||||
```
|
||||
4. caso seja adicionado um ficheiro de imagem como cover, então deve ser utilizada a opção de colocar quer o ficheiro markdown quer o ficheiro de imagem, dentro da uma sub-directoria de `content/eventos`, seguir as recomendações anteriores para esse caso e colocar a imagem (idealmente em formato svg), dentro da subdirectoria do evento.
|
||||
3. caso haja uma imagem de cover, ela deve ser colocada na directoria do evento e ter o nome `cover` (por exemplo: cover.svg, ou cover.png).
|
||||
|
||||
|
||||
Exemplo de layout de ficheiros:
|
||||
```
|
||||
content/eventos/
|
||||
.
|
||||
..
|
||||
AAAA-MM-DD-megahackaton/
|
||||
.
|
||||
..
|
||||
index.md
|
||||
cover.svg
|
||||
```
|
||||
|
||||
# Licença
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user