diff --git a/Readme.md b/Readme.md index 2324f87..8070108 100644 --- a/Readme.md +++ b/Readme.md @@ -2,7 +2,31 @@ ## Novo evento para a agenda: -Os eventos são adicionados à agenda criando um novo ficheiro em [content/eventos/](./content/eventos). Adicionalmente pode ser adicionado um ficheiro com uma imagem para "cover", idealmente no formato svg. +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 + +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: +``` +--- +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 HH:MM + finish: AAAA-MM-DD HH:MM +--- +``` +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. # Licença