Skip to content

Commit

Permalink
Aggiunta sezione sui metadati al README
Browse files Browse the repository at this point in the history
  • Loading branch information
etabeta1 committed Nov 10, 2023
1 parent b201be5 commit 4dadd68
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

0 comments on commit 4dadd68

Please sign in to comment.