From 4dadd68675241292978f115657f50dd8aa5c3a35 Mon Sep 17 00:00:00 2001 From: Andrea Oggioni Date: Fri, 10 Nov 2023 20:58:51 +0100 Subject: [PATCH] Aggiunta sezione sui metadati al README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 8b572a5..9b824cc 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,23 @@ Visita il sito per consultare gli appunti: https://appunti.titilda.org Puoi aggiungere nuovi appunti in formato Markdown (con $\TeX$) rispettando la *filename/directory structure* esistente. GitHub Actions è configurato per renderizzarli in HTML automaticamente usando Pandoc, generare una pulitissima pagina di indice con Bootstrap CSS, e caricarli sul sito GitHub Pages assieme al magnifico CSS custom presente su questo repo (cortesia di @etabeta1 🙌). **NOTA:** se vuoi apportare modifiche al repository senza lanciare un CI workflow (i.e. senza ri-renderizzare tutto), è sufficiente iniziare il *Commit Message* con `skip ci`. + +### Metadati + +All'interno degli appunti è possibile aggiungere dei metadati. + +Al momento i metadati supportati sono i seguenti + +1. title +2. author +3. date + +Per aggiungere tali metadati ad un file markdown, è sufficiente aggiungere le seguenti righe al sui inizio: + + --- + title: "Titolo" + author: + - "Autore 1" + - "Autore 2" + date: 1 Gennaio 1970 + ---