Rewrite user docs, trim developer-only _docs pages, add python-multipart
This commit is contained in:
brutsalvadi
@@ -1,12 +0,0 @@
|
||||
---
|
||||
title: Astro-Bloomz
|
||||
date: '2023-10-04'
|
||||
---
|
||||
|
||||
Astro-Bloomz è un [[digital-garden]], la cui caratteristica principale sono i [[wikirefs]] (detti anche "link bidirezionali"). Si tratta di link che usano la sintassi `[[doppia-parentesi-quadra]]` per collegare file all'interno di una collezione di documenti markdown. Possono essere usati in qualsiasi file markdown del sito, a patto che i nomi dei file siano univoci.
|
||||
|
||||
I "Bloomz" sono le parti di un giardino digitale in stile [[wikibonsai]] pensate per essere condivise, mostrate e incrociate — ma attento a non farti pungere! 🐝
|
||||
|
||||
I giardini in stile [[wikibonsai]] aggiungono in particolare un [[semantic-tree]], visualizzabile come una sorta di albero di #tag chiamato [mappa](/map). È costruito a partire dai [[index-type|file indice]], il cui contenuto ne definisce la struttura tramite liste markdown e `[[wikirefs]]`. I file collegati nell'albero semantico sono principalmente [[entry-type|entry]], che fungono da riepiloghi concettuali, in modo simile a una pagina di Wikipedia. Ogni entry mostra anche i riferimenti a ritroso, ovvero quali altri post la citano.
|
||||
|
||||
Queste sintassi e questo modo di lavorare mirano a rendere grandi quantità di contenuti più facilmente navigabili, senza dover ricorrere ad algoritmi e meccanismi di ricerca opachi (anche se questi sono generalmente disponibili).
|
||||
@@ -1,12 +0,0 @@
|
||||
---
|
||||
title: 🪴 Digital Garden
|
||||
date: '2021-08-04'
|
||||
---
|
||||
|
||||
La caratteristica distintiva di un [digital garden](https://twitter.com/wibomd/status/1703946098589548622) è il `[[wikiref]]` (o "[[wikirefs|link bidirezionale]]"). Aggiungendo una fitta rete di link interni, le pagine di un sito diventano descrittive di una topografia di concetti che le descrivono o ne vengono utilizzati.
|
||||
|
||||
Le tecniche osservate in natura sono tipicamente un mix derivato da [personal knowledge management](https://en.wikipedia.org/wiki/Personal_knowledge_management), [personal wiki](https://en.wikipedia.org/wiki/Personal_wiki), [tools for thought](https://numinous.productions/ttft/), [zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) ed [evergreen notes](https://entries.andymatuschak.org/z4SDCZQeRo4xFEQ8H4qrSqd68ucpgE6LU155C), tra gli altri.
|
||||
|
||||
_[[wikibonsai|WikiBonsai]]_ è la sintesi e la cura di ciò che questo particolare giardiniere ha imparato e costruito.
|
||||
|
||||
Curiosità: "giardinaggio" è una metafora sorprendentemente comune che [spunta](https://twitter.com/wibomd/status/1704147337738654189) nei posti più inaspettati.
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
title: Tipo di Documento
|
||||
---
|
||||
|
||||
I tipi di documento, o "doctype", sono sinonimi delle [content collection di Astro](https://docs.astro.build/en/guides/content-collections/). Sono tipi di documenti markdown usati per renderizzare i contenuti in modi specifici. I seguenti sono i doctype previsti in un [[digital-garden]] stile [[wikibonsai]]:
|
||||
|
||||
- [`posts`](https://docs.astro.build/en/guides/cms/keystatic/#creating-a-new-post)
|
||||
- [[index-type]]
|
||||
- [[entry-type]]
|
||||
@@ -1,22 +0,0 @@
|
||||
---
|
||||
title: DocType Entry
|
||||
---
|
||||
|
||||
Come in un dizionario, un'enciclopedia o Wikipedia, le entry sono uno dei tipi di documento centrali di questo template (insieme agli [[index-type]] e ai [[post-type]]). Sono concetti e idee atomici, significativamente [[wikirefs|collegati]] tra loro in modo da rendere comprensibile come quei concetti si relazionano.
|
||||
|
||||
Il percorso breadcrumb è formato dalla posizione dell'entry corrente nell'[[semantic-tree]]. I link nel footer sono costruiti sia dalla sua posizione nell'albero sia dai [[wikirefs]] in avanti e a ritroso.
|
||||
|
||||
### Markdown
|
||||
|
||||
Le entry conterranno tipicamente frontmatter e/o wikiattr, seguiti dal testo markdown:
|
||||
|
||||
```markdown
|
||||
---
|
||||
frontmatter: attributi
|
||||
---
|
||||
|
||||
:tipo::[[wikiattr]]
|
||||
|
||||
Segue il resto del testo del documento,
|
||||
che potrà contenere altri [[wikilink]].
|
||||
```
|
||||
@@ -1,62 +0,0 @@
|
||||
---
|
||||
title: DocType Index
|
||||
---
|
||||
|
||||
I documenti indice sono il metodo principale per strutturare l'[[semantic-tree]]. Sono uno dei tipi di documento centrali di questo template (insieme agli [[entry-type]] e ai [[post-type]]).
|
||||
|
||||
### Navigazione
|
||||
|
||||
- Tramite la [[map-page]].
|
||||
- Tramite i [[wikirefs]].
|
||||
|
||||
### Markdown
|
||||
|
||||
I file indice costruiscono l'[[semantic-tree]], visualizzabile nella [[map-page]]. Vanno collocati nella directory `./content/index/` e ciascuno deve contenere un elenco markdown con [[wikirefs]] che puntano tipicamente a [[entry-type|entry]] (ma possono puntare a qualsiasi [[doctype]]). Possono contenere o meno frontmatter yaml.
|
||||
|
||||
I documenti devono avere questa forma (senza i commenti):
|
||||
|
||||
(i caratteri di escape `\\` sono aggiunti per mostrare il testo grezzo)
|
||||
|
||||
```markdown
|
||||
// file: i.bonsai.md
|
||||
|
||||
- [[bk.how-to-read-a-book]]
|
||||
- [[read]]
|
||||
- [[4-levels-of-reading]]
|
||||
- [[elementary-reading]]
|
||||
- [[inspectional-reading]]
|
||||
- [[analytical-reading]]
|
||||
- [[syntopical-reading]]
|
||||
```
|
||||
|
||||
L'albero può essere suddiviso in più file indice:
|
||||
|
||||
```markdown
|
||||
// file: i.bonsai.md
|
||||
|
||||
- [[bk.how-to-read-a-book]]
|
||||
- [[i.read]]
|
||||
```
|
||||
|
||||
```markdown
|
||||
// file: i.read.md
|
||||
|
||||
- [[4-levels-of-reading]]
|
||||
- [[elementary-reading]]
|
||||
- [[inspectional-reading]]
|
||||
- [[analytical-reading]]
|
||||
- [[syntopical-reading]]
|
||||
```
|
||||
|
||||
Entrambi gli esempi genereranno un albero con questa struttura:
|
||||
|
||||
```markdown
|
||||
i.bonsai
|
||||
└── bk.how-to-read-a-book
|
||||
└── i.read
|
||||
└── 4-levels-of-reading
|
||||
├── elementary-reading
|
||||
├── inspectional-reading
|
||||
├── analytical-reading
|
||||
└── syntopical-reading
|
||||
```
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Pagina Mappa
|
||||
---
|
||||
|
||||
Questa pagina mostra l'[[semantic-tree]] completo generato dai documenti [[index-type]].
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
title: Guida rapida al markdown
|
||||
---
|
||||
|
||||
Markdown è il formato di testo usato per scrivere le pagine. Basta qualche simbolo per formattare il testo.
|
||||
|
||||
## Titoli
|
||||
|
||||
```
|
||||
## Titolo grande
|
||||
### Titolo medio
|
||||
#### Titolo piccolo
|
||||
```
|
||||
|
||||
## Grassetto e corsivo
|
||||
|
||||
```
|
||||
**testo in grassetto**
|
||||
_testo in corsivo_
|
||||
```
|
||||
|
||||
## Liste
|
||||
|
||||
```
|
||||
- Primo elemento
|
||||
- Secondo elemento
|
||||
- Terzo elemento
|
||||
```
|
||||
|
||||
Lista numerata:
|
||||
|
||||
```
|
||||
1. Prima cosa
|
||||
2. Seconda cosa
|
||||
3. Terza cosa
|
||||
```
|
||||
|
||||
## Link
|
||||
|
||||
```
|
||||
[testo del link](https://esempio.com)
|
||||
```
|
||||
|
||||
## Immagine
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
Le immagini si caricano dall'editor con il pulsante **+ Immagine** in fondo alla schermata di modifica.
|
||||
|
||||
## Wikilink
|
||||
|
||||
```
|
||||
[[nome-della-pagina]]
|
||||
```
|
||||
|
||||
Vedi [[wikirefs]] per tutti i dettagli.
|
||||
|
||||
## Citazione
|
||||
|
||||
```
|
||||
> Testo citato
|
||||
```
|
||||
|
||||
## Codice inline
|
||||
|
||||
```
|
||||
`codice`
|
||||
```
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Remark-WikiRefs
|
||||
---
|
||||
|
||||
Il pacchetto `remark-wikirefs` è responsabile della gestione della sintassi markdown dei [[wikirefs]]. È disponibile su [GitHub](https://github.com/wikibonsai/remark-wikirefs).
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
title: Albero Semantico
|
||||
---
|
||||
|
||||
:plugin::[[semtree]]
|
||||
|
||||
L'albero semantico è costruito con il plugin [[semtree]] (vedi la documentazione per i dettagli). È definito dai documenti [[index-type]] in formato markdown. Forma una gerarchia concettuale con lo scopo di orientare il lettore all'interno dei concetti del sito.
|
||||
|
||||
Vale la pena ripeterlo:
|
||||
|
||||
> "È importante considerare la conoscenza come una sorta di albero semantico. Assicurati di comprendere i principi fondamentali — ovvero il tronco e i rami principali — prima di addentrarsi nelle foglie e nei dettagli, altrimenti non avranno nulla a cui aggrapparsi."
|
||||
>
|
||||
> ~ [Elon Musk](https://www.reddit.com/r/IAmA/comments/2rgsan/comment/cnfre0a/?utm_source=share&utm_medium=web2x&context=3)
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: SemTree
|
||||
---
|
||||
|
||||
Il pacchetto `semtree` è responsabile della costruzione dell'[[semantic-tree]]. È disponibile su [GitHub](https://github.com/wikibonsai/semtree).
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Test Render
|
||||
date: '2023-10-05'
|
||||
---
|
||||
|
||||
Questo file serve specificamente a testare il rendering dei [[wikirefs]] come wikiembed.
|
||||
@@ -1,244 +0,0 @@
|
||||
---
|
||||
title: Test
|
||||
date: '2021-08-04'
|
||||
---
|
||||
|
||||
Questa pagina serve a testare e mostrare gli stili markdown disponibili in questo template.
|
||||
|
||||
## Markdown
|
||||
|
||||
(alcuni caratteri di escape `\` sono aggiunti per mostrare il testo grezzo)
|
||||
|
||||
### WikiRefs
|
||||
|
||||
#### WikiAttr con prefisso (vedi attrbox per l'output)
|
||||
|
||||
```markdown
|
||||
:prefixed-wikiattr::[[wikirefs]]
|
||||
```
|
||||
|
||||
:prefixed-wikiattr::[[wikirefs]]
|
||||
|
||||
#### Lista WikiAttr con prefisso (vedi attrbox per l'output)
|
||||
|
||||
```markdown
|
||||
: prefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
```
|
||||
|
||||
: prefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
|
||||
#### WikiAttr senza prefisso (vedi attrbox per il rendering)
|
||||
|
||||
```markdown
|
||||
unprefixed-wikiattr::[[wikirefs]]
|
||||
```
|
||||
|
||||
unprefixed-wikiattr::[[wikirefs]]
|
||||
|
||||
#### Lista WikiAttr senza prefisso (vedi attrbox per il rendering)
|
||||
|
||||
```markdown
|
||||
unprefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
```
|
||||
|
||||
unprefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
|
||||
#### Un WikiLink
|
||||
|
||||
```markdown
|
||||
[[digital-garden]]
|
||||
```
|
||||
|
||||
[[digital-garden]]
|
||||
|
||||
#### Un WikiLink tipizzato (controlla l'HTML per la classe CSS linktype)
|
||||
|
||||
```markdown
|
||||
:typed-wikilink::[[digital-garden]].
|
||||
```
|
||||
|
||||
:typed-wikilink::[[digital-garden]].
|
||||
|
||||
#### Un WikiEmbed (Markdown)
|
||||
|
||||
```markdown
|
||||
![[test-render]]
|
||||
```
|
||||
|
||||
![[test-render]]
|
||||
|
||||
#### Un WikiEmbed (Immagine)
|
||||
|
||||
```markdown
|
||||
![[wikibonsai-way.png]]
|
||||
```
|
||||
|
||||
![[wikibonsai-way.png]]
|
||||
|
||||
#### Zombie (link a pagine inesistenti)
|
||||
|
||||
#### WikiAttr con prefisso zombie (vedi attrbox per il rendering)
|
||||
|
||||
```markdown
|
||||
:zombie-wikiattr::[[zombie]]
|
||||
```
|
||||
|
||||
:zombie-wikiattr::[[zombie]]
|
||||
|
||||
#### Lista WikiAttr con prefisso zombie (vedi attrbox per il rendering)
|
||||
|
||||
```markdown
|
||||
: zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
```
|
||||
|
||||
: zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
|
||||
#### WikiAttr senza prefisso zombie (vedi attrbox per il rendering)
|
||||
|
||||
```markdown
|
||||
zombie-wikiattr::[[zombie]]
|
||||
```
|
||||
|
||||
zombie-wikiattr::[[zombie]]
|
||||
|
||||
#### Lista WikiAttr senza prefisso zombie (vedi attrbox per il rendering)
|
||||
|
||||
```markdown
|
||||
zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
```
|
||||
|
||||
zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
|
||||
#### WikiLink zombie
|
||||
|
||||
```markdown
|
||||
[[zombie]]
|
||||
```
|
||||
|
||||
[[zombie]]
|
||||
|
||||
#### WikiLink tipizzato zombie
|
||||
|
||||
```markdown
|
||||
:zombie-typed-wikilink::[[zombie]].
|
||||
```
|
||||
|
||||
:zombie-typed-wikilink::[[zombie]].
|
||||
|
||||
#### WikiEmbed zombie
|
||||
|
||||
```markdown
|
||||
![[zombie]]
|
||||
```
|
||||
|
||||
![[zombie]]
|
||||
|
||||
#### Intestazioni
|
||||
|
||||
```markdown
|
||||
# Intestazione 1
|
||||
## Intestazione 2
|
||||
### Intestazione 3
|
||||
#### Intestazione 4
|
||||
##### Intestazione 5
|
||||
###### Intestazione 6
|
||||
```
|
||||
|
||||
# Intestazione 1
|
||||
## Intestazione 2
|
||||
### Intestazione 3
|
||||
#### Intestazione 4
|
||||
##### Intestazione 5
|
||||
###### Intestazione 6
|
||||
|
||||
#### Liste
|
||||
|
||||
```markdown
|
||||
- Uno
|
||||
- Due
|
||||
- Tre
|
||||
```
|
||||
|
||||
- Uno
|
||||
- Due
|
||||
- Tre
|
||||
|
||||
#### Citazione
|
||||
|
||||
```markdown
|
||||
> Citazione.
|
||||
```
|
||||
|
||||
> Citazione.
|
||||
|
||||
#### Link web
|
||||
|
||||
```markdown
|
||||
[Link web](https://astro-bloomz.netlify.app)
|
||||
```
|
||||
|
||||
[Link web](https://astro-bloomz.netlify.app)
|
||||
|
||||
#### Blocco di codice
|
||||
|
||||
```javascript
|
||||
// javascript
|
||||
for (var i=1; i < 101; i++){
|
||||
if (i % 15 == 0) console.log("FizzBuzz");
|
||||
else if (i % 3 == 0) console.log("Fizz");
|
||||
else if (i % 5 == 0) console.log("Buzz");
|
||||
else console.log(i);
|
||||
}
|
||||
```
|
||||
|
||||
```ruby
|
||||
# ruby
|
||||
1.upto 100 do |i|
|
||||
string = ""
|
||||
string += "Fizz" if i % 3 == 0
|
||||
string += "Buzz" if i % 5 == 0
|
||||
puts "#{i} = #{string}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Codice inline
|
||||
|
||||
```markdown
|
||||
Va bene, `va bene`, va bene.
|
||||
```
|
||||
|
||||
Va bene, `va bene`, va bene.
|
||||
|
||||
#### Tabelle
|
||||
|
||||
```markdown
|
||||
| Conigli | Volpi | Ricci |
|
||||
|:------- |:-----:| -----:|
|
||||
| 25 | 3 | 12 |
|
||||
| 100 | 10 | 20 |
|
||||
```
|
||||
|
||||
| Conigli | Volpi | Ricci |
|
||||
|:------- |:-----:| -----:|
|
||||
| 25 | 3 | 12 |
|
||||
| 100 | 10 | 20 |
|
||||
|
||||
#### Testo lungo
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla imperdiet, eros in aliquet eleifend, felis tellus laoreet velit, a feugiat purus mi at arcu. Sed tempor congue gravida. Suspendisse sodales ultricies lacus, nec consequat mauris dictum in. Aliquam at lacus sodales, porta velit in, consequat mauris. Maecenas consequat fermentum tortor, vitae tincidunt sem porta vel. Sed elementum dui libero, vitae bibendum est imperdiet non. Curabitur sit amet libero quis nulla faucibus euismod. Cras condimentum ante tortor, a sollicitudin elit accumsan eget.
|
||||
@@ -1,12 +0,0 @@
|
||||
---
|
||||
title: WikiBonsai
|
||||
---
|
||||
|
||||
![[wikibonsai-way.png]][^twt]
|
||||
|
||||
Astro-Bloomz è un progetto [WikiBonsai](https://github.com/wikibonsai/wikibonsai).
|
||||
|
||||
![[astro-bloomz]]
|
||||
|
||||
|
||||
[^twt]: [spiegazione](https://twitter.com/wibomd/status/1703930973371412699)
|
||||
+26
-8
@@ -1,19 +1,37 @@
|
||||
---
|
||||
title: WikiRefs
|
||||
title: Come usare i wikilink
|
||||
---
|
||||
|
||||
plugin::[[remark-wikirefs]]
|
||||
Un wikilink collega una pagina a un'altra. Si scrive così:
|
||||
|
||||
```
|
||||
[[nome-della-pagina]]
|
||||
```
|
||||
|
||||
I `[[WikiRefs]]`[^nomi] sono una parte fondamentale del mondo del [[digital-garden|digital gardening]]. Sono il mattone di base dell'interconnessione realizzata in molti giardini digitali, incluso questo. Vengono renderizzati con il plugin [[remark-wikirefs]], appaiono in un colore diverso rispetto ai link web esterni, e puoi consultare quella documentazione per ulteriori dettagli.
|
||||
## Come funziona
|
||||
|
||||
In breve, questo particolare tipo di `[[wikirefs]]` comprende tre costrutti wiki: wikiattr, wikilink e wikimbed.
|
||||
Scrivi il nome della pagina tra doppie parentesi quadre. Il sistema crea il link automaticamente. Nella pagina collegata comparirà in fondo la lista delle pagine che la citano.
|
||||
|
||||
I _WikiAttr_ sono attributi formalizzati di un file. Includono un tipo di attributo descrittivo e un wikilink a un altro file. Si scrivono `:così::[[wikilink]]` (con un'a capo dopo) e vengono renderizzati nell'attributebox (attrbox).
|
||||
## Esempio
|
||||
|
||||
I _WikiLink_ sono i tradizionali link bidirezionali con la sintassi a parentesi quadre e possono comparire ovunque in un file. Esistono `:tipizzati::[[wikilink]]` e normali `[[wikilink]]` non tipizzati. Sono evidenziati in un colore diverso rispetto ai link web esterni.
|
||||
Stai scrivendo un racconto di un tour e vuoi rimandare alla pagina sull'equipaggiamento:
|
||||
|
||||
I _WikiEmbed_ incorporano il contenuto del file collegato direttamente nella pagina corrente. È possibile incorporare file markdown, immagini, audio o video. I WikiEmbed si scrivono `![[così]]`.
|
||||
```
|
||||
Per i dettagli su cosa portare, vedi [[zaino-da-bikepacking]].
|
||||
```
|
||||
|
||||
## Collegare una categoria
|
||||
|
||||
[^nomi]: "wikiref" porta in realtà molti nomi: "[wikilink](https://en.wikipedia.org/wiki/Help:Link)", "[link bidirezionale](https://maggieappleton.com/bidirectionals)", "[wikitext linking](https://tiddlywiki.com/#Linking%20in%20WikiText)", "backlink", "[link interno](https://help.obsidian.md/How+to/Internal+link)", per citarne solo alcuni...
|
||||
Per posizionare una pagina sotto una categoria, aggiungi il wikilink della categoria da qualche parte nel testo:
|
||||
|
||||
```
|
||||
Questo fa parte di [[BincioTour]].
|
||||
```
|
||||
|
||||
Le categorie disponibili sono: [[BincioTech]], [[BincioOfficina]], [[BincioTour]], [[BincioCorsa]], [[BincioAbbigliamento]].
|
||||
|
||||
Nell'editor, il wikilink della categoria viene inserito automaticamente quando scegli la sezione dal menu.
|
||||
|
||||
## Il nome nel link
|
||||
|
||||
Il nome nel link deve corrispondere esattamente al nome file della pagina (senza `.md`). Se la pagina si chiama `garmin-edge-540.md`, il link sarà `[[garmin-edge-540]]`.
|
||||
|
||||
Reference in New Issue
Block a user