From f44f4699ff5f8063c60e1af0101c11e5e1d6f382 Mon Sep 17 00:00:00 2001 From: Antonio De Lucreziis Date: Mon, 7 Oct 2024 21:35:38 +0200 Subject: [PATCH] chore: lievi correzzioni/aggiunte --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bf436f0..67721b5 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,13 @@ Questo sito è realizzato in Astro e serve come supporto per il tutorato di matematica del corso di laurea in Matematica dell'Università di Pisa. - -## Per i tutors +## Per i Tutor ### Accedere a Gitea Collegati a [Gitea](https://git.phc.dm.unipi.it/) e clicca sul tasto Sign in. Nella finestra clicca su Sign in With Google, e successivamente scrivi il tuo indirizzo email di ateneo -(ad esempio, nome.cognome@studenti.unipi.it), poi procedi con l'usuale login per i servizi di Ateneo. +(ad esempio, `nome.cognome@studenti.unipi.it`), poi procedi con l'usuale login per i servizi di Ateneo. ### Editare file @@ -17,42 +16,51 @@ Per potere modificare i file, è necessario chiedere ai Macchinisti di aggiornar i permessi del proprio account, passando in PHC o mandando una mail. Entra nel [repository](https://git.phc.dm.unipi.it/phc/tutorato) e raggiungi la -cartella tutorato/src/pages/archivio/[Anno corrente]. Qui troverai il file +cartella `src/pages/archivio/[Anno corrente]`. Qui troverai il file relativo al tuo tutorato (o se non esiste, chiedi ai macchinisti), ad esempio -quello relativo al corso di aritmetica è "aritmetica.md". +quello relativo al corso di aritmetica è "aritmetica.md". + Cliccando sul file è possibile aprire l'editor di testo cliccando sulla matita in alto a destra (se tale icona non risulta cliccabile, contatta i macchinisti). -#### Scrivere in Latex +#### Scrivere in LaTeX Il file del tutorato è in formato Markdown ([Guida alla sintassi Markdown](https://www.markdownguide.org/basic-syntax/)), ed è possibile scrivere in LaTeX tramite KaTeX, il quale supporta molti degli -usuali environments di LaTeX come, ad esempio, $ $ oppure $$ $$ oppure \[ \]. -Per famigliarizzarti con scrivere LaTeX in Markdown, vedi la pagina [esempio](https://git.phc.dm.unipi.it/phc/tutorato/src/branch/main/src/pages/archivio/2024-2025/esempio.md) +usuali environments di LaTeX come, ad esempio `$...$` o `\(...\)` per ambiente _inline_ oppure `$$...$$` o `\[...\]` per _display_. + +Per famigliarizzarti con scrivere LaTeX in Markdown, vedi [la pagina di esempio](https://git.phc.dm.unipi.it/phc/tutorato/src/commit/b04d9eafda86b21375e1f9a0e672f47d0e222eca/src/pages/archivio/2024-2025/esempio.md) e [la lista dei simboli supportati da KaTeX](https://katex.org/docs/support_table). #### Caricare files È anche possibile includere link di files nella pagina, spostandosi nella cartella -"public/materiale/" e poi cliccando sul menu a tendina "add file". +`public/materiale/` e poi cliccando sul menu a tendina "_Add File_". A questo punto puoi aggiungere un link alla pagina come ``` Tutorato del [13 ottobre 2023](/materiale/TutoratoAnalisi13102023.pdf). ``` +> **Nota**: Il nome del file non deve contenere spazi o caratteri speciali, usare `_` o `-` al posto degli spazi. + ### Editing da locale È anche possibile editare i file da locale con il proprio editor clonando il repository tramite git e facendo push/pull degli aggiornamenti. Per interagire con Gitea in questo modo, la configurazione è analoga a quella di altri servizi come Github -o Gitlab. +o Gitlab (in caso di problemi, contattare i macchinisti). -## Sviluppare +## Preview in locale / Development Per sviluppare in locale è necessario avere installato Bun o NodeJS ```bash +# con "bun" bun install bun dev + +# o con "nodejs/npm" +npm install +npm run dev ```