Add documentation

This commit is contained in:
Ruben 2025-10-03 12:30:04 +02:00
parent c3f821caef
commit 7ad0062dee
34 changed files with 1921 additions and 0 deletions

View file

@ -0,0 +1,2 @@
title = "Formatering med Markdown"
summary = "Lær hvordan du formaterer tekst, bilder og lenker"

View file

@ -0,0 +1,243 @@
# Formatering med Markdown
Markdown er et enkelt format for å skrive tekst med formatering. Du skriver ren tekst med noen enkle symboler for å markere overskrifter, lenker, bilder osv.
## Overskrifter
Bruk `#` for overskrifter. Flere `#` gir mindre overskrifter:
```markdown
# Hovedoverskrift (H1)
## Underoverskrift (H2)
### Mindre overskrift (H3)
```
**Viktig**: Den første `# Overskrift` i dokumentet blir sidens tittel (hvis du ikke setter tittel i metadata.ini).
## Avsnitt
Skriv vanlig tekst for avsnitt. Separer avsnitt med en tom linje:
```markdown
Dette er et avsnitt.
Dette er et nytt avsnitt.
```
## Uthevet tekst
```markdown
**Fet tekst** eller __fet tekst__
*Kursiv tekst* eller _kursiv tekst_
***Fet og kursiv***
```
Resultat:
- **Fet tekst**
- *Kursiv tekst*
- ***Fet og kursiv***
## Lister
### Punktliste
```markdown
- Punkt 1
- Punkt 2
- Punkt 3
```
Eller bruk `*`:
```markdown
* Punkt 1
* Punkt 2
```
### Nummerert liste
```markdown
1. Første punkt
2. Andre punkt
3. Tredje punkt
```
### Nestet liste
```markdown
- Hovedpunkt
- Underpunkt
- Enda et underpunkt
- Nytt hovedpunkt
```
## Lenker
```markdown
[Lenketekst](https://eksempel.no)
```
Resultat: [Lenketekst](https://eksempel.no)
### Lenke til annen side på samme nettsted
```markdown
[Les mer](../annen-side/)
```
## Bilder
```markdown
![Bildetekst](bilde.jpg)
```
### Bildefil i samme mappe
```markdown
![Mitt foto](foto.jpg)
```
### Bildefil i undermappe
```markdown
![Mitt foto](bilder/foto.jpg)
```
### Forsidebilde
Gi bildet navnet `cover.jpg`, `cover.webp` eller `cover.png`. Det vises automatisk i listevisninger (f.eks. på bloggsiden).
## Sitater
Bruk `>` for sitater:
```markdown
> Dette er et sitat.
> Det kan gå over flere linjer.
```
Resultat:
> Dette er et sitat.
> Det kan gå over flere linjer.
## Kode
### Kode i teksten (inline)
```markdown
Bruk `kode` i teksten slik.
```
Resultat: Bruk `kode` i teksten slik.
### Kodeblokk
Bruk tre backticks (`` ` ``) før og etter:
````markdown
```
Dette er en kodeblokk
med flere linjer
```
````
Med syntaksutheving:
````markdown
```php
<?php
echo "Hei verden";
?>
```
````
## Horisontale linjer
```markdown
---
```
Eller:
```markdown
***
```
Resultat:
---
## Tabeller
```markdown
| Kolonne 1 | Kolonne 2 | Kolonne 3 |
|-----------|-----------|-----------|
| Rad 1, celle 1 | Rad 1, celle 2 | Rad 1, celle 3 |
| Rad 2, celle 1 | Rad 2, celle 2 | Rad 2, celle 3 |
```
Resultat:
| Kolonne 1 | Kolonne 2 | Kolonne 3 |
|-----------|-----------|-----------|
| Rad 1, celle 1 | Rad 1, celle 2 | Rad 1, celle 3 |
| Rad 2, celle 1 | Rad 2, celle 2 | Rad 2, celle 3 |
## HTML i Markdown
Du kan også bruke HTML direkte hvis du trenger mer kontroll:
```markdown
Dette er Markdown-tekst.
<div class="spesiell-boks">
Dette er HTML.
</div>
Tilbake til Markdown.
```
## Beste praksis
### Bruk beskrivende bildetekster
```markdown
<!-- Bra -->
![Solnedgang over fjellene](solnedgang.jpg)
<!-- Dårlig -->
![Bilde](img001.jpg)
```
### Bruk relative lenker
```markdown
<!-- Bra for interne lenker -->
[Om oss](../om-oss/)
<!-- Mindre bra -->
[Om oss](https://dinside.no/om-oss/)
```
### Hold det enkelt
Bruk Markdown-syntaks framfor HTML når det er mulig. HTML skal bare brukes når Markdown ikke strekker til.
## Eksempel på komplett side
```markdown
# Min fantastiske artikkel
Dette er en introduksjon til artikkelen min.
## Hovedinnhold
Her er **hovedinnholdet**. Det kan inneholde:
- Punktlister
- Lenker til [andre sider](../annen-side/)
- Bilder
![Eksempelbilde](bilde.jpg)
## Konklusjon
Dette var det! Enkelt og greit.
```

View file

@ -0,0 +1,2 @@
title = "Kom i gang"
summary = "Publiser din første side på få minutter"

View file

@ -0,0 +1,104 @@
# Kom i gang med å publisere
Lær det grunnleggende om å publisere innhold på din PnP-side.
## Grunnkonseptet
**Mapper blir til nettsideadresser**
Når du oppretter en mappe i `/content/`, blir den automatisk til en nettadresse:
```
/content/om-oss/ → dinside.no/om-oss
/content/blogg/ → dinside.no/blogg
```
## Din første side
### 1. Opprett en mappe
Opprett en mappe i `/content/` med et beskrivende navn:
```
/content/om-oss/
```
### 2. Lag en innholdsfil
Opprett en fil i mappen. Bruk ett av disse navnene:
- `page.md` - For vanlige sider
- `article.md` - For artikler og blogginnlegg
- `post.md` - Alternativt navn for artikler
**Eksempel** - Opprett `/content/om-oss/page.md`:
```markdown
# Om oss
Velkommen til vår side. Vi er et team som brenner for å lage
gode nettsider med enkel teknologi.
## Vår filosofi
Enkelhet er styrke. Vi bruker bare det som er nødvendig.
```
### 3. Åpne i nettleseren
Gå til `dinside.no/om-oss` - siden din er nå publisert!
## Legg til et blogginnlegg
### 1. Opprett en mappe med dato
For blogginnlegg, bruk datoformat i mappenavnet:
```
/content/blogg/2025-01-15-mitt-forste-innlegg/
```
Datoen (2025-01-15) trekkes automatisk ut og vises i norsk format: "15. januar 2025"
### 2. Lag innholdsfilen
Opprett `/content/blogg/2025-01-15-mitt-forste-innlegg/article.md`:
```markdown
# Mitt første innlegg
Dette er mitt første blogginnlegg. Så enkelt er det!
## Legg til bilder
Du kan legge til bilder ved å bare dra dem inn i mappen.
![Beskrivelse av bildet](bilde.jpg)
```
### 3. Legg til et bilde
Dra `bilde.jpg` inn i samme mappe. Bildet er nå tilgjengelig i innlegget.
### 4. Åpne i nettleseren
Gå til `dinside.no/blogg/2025-01-15-mitt-forste-innlegg/`
## Automatiske lister
Når en mappe inneholder andre mapper (ikke bare filer), lages det automatisk en liste:
```
/content/blogg/
├── 2025-01-15-mitt-forste-innlegg/
├── 2025-01-20-andre-innlegg/
└── 2025-01-25-tredje-innlegg/
```
Når du besøker `/blogg`, får du en liste over alle innleggene.
## Neste steg
- Lær hvordan du [formaterer tekst med Markdown](../formatering/)
- Legg til [metadata](../metadata/) for å kontrollere titler og menyer
- Forstå [forskjellen mellom sidetyper](../sidetyper/)

View file

@ -0,0 +1,3 @@
title = "Brukerveiledning"
summary = "Lær hvordan du publiserer innhold uten programmeringskunnskaper"
show_date = false

View file

@ -0,0 +1,2 @@
title = "Metadata"
summary = "Kontroller titler, datoer og menyvisning med metadata.ini"

View file

@ -0,0 +1,169 @@
# Metadata
Metadata lar deg kontrollere hvordan innholdet ditt vises. Du legger metadata i en fil som heter `metadata.ini`.
## Hva er metadata?
Metadata er informasjon *om* innholdet ditt, for eksempel:
- Tittel
- Publiseringsdato
- Kort beskrivelse
- Om siden skal vises i menyen
## Opprett metadata.ini
Lag en fil som heter `metadata.ini` i samme mappe som innholdsfilen:
```
/content/om-oss/
├── page.md
└── metadata.ini
```
## Grunnleggende felt
### Tittel
Overstyr tittelen som vises:
```ini
title = "Om oss - Hvem vi er"
```
Hvis du ikke setter tittel, brukes første `# Overskrift` fra innholdsfilen.
### Dato
Sett publiseringsdatoen:
```ini
date = "2025-01-15"
```
Datoen formateres automatisk til norsk: "15. januar 2025"
For blogginnlegg trekkes datoen automatisk fra mappenavnet (`2025-01-15-innlegg`), men du kan overstyre med metadata.
### Sammendrag
Legg til et kort sammendrag som vises i listevisninger:
```ini
summary = "Lær mer om hvem vi er og hva vi driver med."
```
## Menyinnstillinger
### Vis i meny
For å vise siden i navigasjonsmenyen:
```ini
menu = true
```
### Menyen rekkefølge
Kontroller rekkefølgen i menyen (lavere tall vises først):
```ini
menu = true
menu_order = 1
```
Eksempel:
- `menu_order = 1` → Vises først
- `menu_order = 2` → Vises som nummer to
- `menu_order = 10` → Vises senere
## Komplett eksempel
**`/content/om-oss/metadata.ini`:**
```ini
title = "Om oss"
summary = "Lær mer om vårt team og vår filosofi"
menu = true
menu_order = 1
```
## Blogginnlegg med metadata
**`/content/blogg/2025-01-15-mitt-innlegg/metadata.ini`:**
```ini
title = "Mitt fantastiske blogginnlegg"
date = "2025-01-15"
summary = "I dette innlegget deler jeg mine tanker om enkel webpublisering."
```
**Merk**: Du trenger ikke `menu = true` for blogginnlegg - de vises automatisk i blogglisten.
## Metadata for mapper
Du kan også legge metadata.ini i mapper som inneholder andre mapper:
**`/content/blogg/metadata.ini`:**
```ini
title = "Blogg"
summary = "Les våre siste artikler og nyheter"
menu = true
menu_order = 2
```
Dette påvirker hvordan bloggen vises i menyen og i listevisninger.
## Hva skjer uten metadata.ini?
Hvis du ikke har metadata.ini, bruker systemet:
- **Tittel**: Første `# Overskrift` i innholdsfilen, eller mappenavnet
- **Dato**: Dato fra mappenavn (`YYYY-MM-DD-navn`), eller filens endringsdato
- **Meny**: Vises ikke i menyen
- **Sammendrag**: Vises ikke
## Flerspråklige sider
Hvis nettsiden har flere språk, kan du legge til oversettelser i metadata.ini:
```ini
title = "Om oss"
summary = "Lær mer om oss"
menu = true
[en]
title = "About us"
summary = "Learn more about us"
```
Den norske tittelen brukes som standard, og den engelske tittelen brukes når siden vises på engelsk.
## Tips
### Bruk beskrivende titler
```ini
# Bra
title = "Om oss - Vår historie og verdier"
# Mindre bra
title = "Om oss"
```
### Skriv gode sammendrag
Sammendrag skal være 1-2 setninger som oppsummerer innholdet:
```ini
summary = "Lær hvordan du publiserer innhold enkelt og raskt med vårt system."
```
### Hold datoformatet korrekt
Bruk alltid formatet `YYYY-MM-DD`:
```ini
# Riktig
date = "2025-01-15"
# Feil
date = "15.01.2025"
date = "15/01/2025"
```

View file

@ -0,0 +1,35 @@
# Brukerveiledning
Denne dokumentasjonen er for deg som skal publisere innhold. Du trenger ingen programmeringskunnskaper - bare evnen til å opprette mapper og redigere tekstfiler.
## Slik fungerer det
Du jobber direkte med mapper og filer i `/content/`-mappen. Når du lagrer en fil, publiseres innholdet umiddelbart på nettsiden.
### Sett opp tilgang via WebDAV
1. Koble til `/content/`-mappen som en nettverksdisk via WebDAV
2. Mappen vises som en vanlig mappe på datamaskinen din
3. Alle endringer du gjør publiseres automatisk
## Kom i gang
### [Kom i gang](kom-i-gang/)
Lær det grunnleggende om å publisere innhold.
### [Formatering med Markdown](formatering/)
Slik formaterer du tekst, bilder og lenker.
### [Metadata](metadata/)
Legg til titler, datoer og annen informasjon til sidene dine.
### [Sidetyper](sidetyper/)
Forstå forskjellen mellom sider, artikler og lister.
## Rask sjekkliste
✓ Opprett en mappe med et beskrivende navn
✓ Legg til en fil: `page.md`, `article.md` eller `post.md`
✓ Skriv innholdet i Markdown
✓ Legg til `metadata.ini` for å kontrollere tittel, dato og meny
✓ Lagre - innholdet er nå publisert!

View file

@ -0,0 +1,2 @@
title = "Sidetyper"
summary = "Forstå forskjellen mellom sider, artikler og lister"

View file

@ -0,0 +1,207 @@
# Sidetyper
PnP har tre hovedtyper av innhold: sider, artikler og lister. Forstå forskjellene for å velge riktig type.
## Sider (page.md)
**Bruk for**: Statiske sider som "Om oss", "Kontakt", "Tjenester"
En side er en frittstående side som ikke nødvendigvis er del av en samling.
### Når bruke page.md
- Informasjonssider
- Landingssider
- Om-sider
- Kontaktsider
### Eksempel
```
/content/om-oss/
├── page.md
└── metadata.ini
```
**page.md:**
```markdown
# Om oss
Vi er et team som...
```
**metadata.ini:**
```ini
title = "Om oss"
menu = true
menu_order = 1
```
## Artikler og innlegg (article.md / post.md)
**Bruk for**: Blogginnlegg, nyheter, artikler, meldinger
Artikler er innhold som er del av en samling, ofte med dato.
### Når bruke article.md eller post.md
- Blogginnlegg
- Nyhetsartikler
- Tidsstemplede innlegg
- Innhold som skal vises i en liste
### Eksempel
```
/content/blogg/2025-01-15-mitt-innlegg/
├── article.md
├── metadata.ini
└── cover.jpg
```
**article.md:**
```markdown
# Mitt blogginnlegg
Dette er innholdet i blogginnlegget...
```
**metadata.ini:**
```ini
title = "Mitt fantastiske blogginnlegg"
date = "2025-01-15"
summary = "En kort beskrivelse av innlegget."
```
**cover.jpg**: Forsidebilde som vises i blogglisten
### Forskjell på article.md og post.md
Ingen praktisk forskjell - bruk det du foretrekker:
- `article.md` - For artikler
- `post.md` - For blogginnlegg
Begge behandles likt av systemet.
## Lister (automatiske)
**Bruk for**: Oversiktssider over artikler, produkter, prosjekter
Lister genereres automatisk når en mappe inneholder andre mapper.
### Når lages det automatisk lister
```
/content/blogg/
├── 2025-01-15-innlegg-1/
├── 2025-01-20-innlegg-2/
└── 2025-01-25-innlegg-3/
```
Når du besøker `/blogg`, vises en automatisk liste over alle innleggene.
### Legg til beskrivelse til listen
Lag en `page.md` i samme mappe som undermappene:
```
/content/blogg/
├── page.md ← Beskrivelse av bloggen
├── metadata.ini ← Metadata for bloggen
├── 2025-01-15-innlegg-1/
├── 2025-01-20-innlegg-2/
└── 2025-01-25-innlegg-3/
```
**page.md:**
```markdown
# Vår blogg
Her finner du våre siste artikler og nyheter.
```
**metadata.ini:**
```ini
title = "Blogg"
menu = true
menu_order = 2
```
Beskrivelsen vises øverst på bloggsiden, før listen av innlegg.
## Sammendrag
| Type | Filnavn | Bruk for | Dato | Vises i liste |
|------|---------|----------|------|---------------|
| **Side** | `page.md` | Statiske sider | Valgfri | Hvis del av samling |
| **Artikkel** | `article.md` | Blogginnlegg, artikler | Anbefalt | Ja |
| **Innlegg** | `post.md` | Blogginnlegg | Anbefalt | Ja |
| **Liste** | (automatisk) | Oversikt | - | - |
## Mappestrukturer
### Enkel side
```
/content/kontakt/
├── page.md
└── metadata.ini
```
### Blogg med innlegg
```
/content/blogg/
├── page.md (valgfri beskrivelse)
├── metadata.ini
├── 2025-01-15-forste-innlegg/
│ ├── article.md
│ ├── metadata.ini
│ └── cover.jpg
└── 2025-01-20-andre-innlegg/
├── article.md
├── metadata.ini
└── cover.jpg
```
### Produktkatalog
```
/content/produkter/
├── page.md (beskrivelse av produktene)
├── metadata.ini
├── produkt-1/
│ ├── page.md
│ ├── metadata.ini
│ └── bilde.jpg
└── produkt-2/
├── page.md
├── metadata.ini
└── bilde.jpg
```
## Tips
### Bruk datoer for tidsstempler
```
# Bra for blogginnlegg
/content/blogg/2025-01-15-mitt-innlegg/
# Mindre bra
/content/blogg/mitt-innlegg/
```
### Bruk beskrivende mappenavn
```
# Bra
/content/tjenester/webdesign/
# Mindre bra
/content/tjenester/tjeneste1/
```
### Legg til forsidebilder
For artikler og innlegg, legg til `cover.jpg` for visuell appell i lister.
### Bruk page.md for å beskrive lister
Når du har en mappe med undermapper, legg til `page.md` for å gi kontekst til listen.