Skip to content

Innholdsfiler

Eirik Hoem edited this page Mar 2, 2021 · 5 revisions

Markdown

Innholdet på disse sidene er skrevet i markdown, og alle filer har etternavnet .md eller .markdown. Markdown er et såkalt "lightweight markup language"

Siden Mastering markdown inneholder enkel veileder og gode eksempler på standard markdown, samt den utvidete markdown funksjonaliteten som benyttes i GitHub (GitHub Flavored Markdown (GFM)).

Andre nyttige sider er Markdown Guide.

Verktøy

Det finnes mange ulike verktøy for å redigere markdown filer, og de fleste tekst-editor program støtter dette, og flere har også automatisk mulighet for å gjøre preview av hvordan teksten vil se ut når den publiseres. Det er også gunstig å benytte et verktøy som har god integrasjon/kobling mot GitHub, for å kunne gjøre commit/push/pull direkte fra editoren.

Eksempler:

  • Atom
  • Notepad++
  • Visual Studio Code

Front matter

Front matter benyttes for å sette ulike parametre og metadata-informasjon på innholdsfilene. Front matter benytter yaml syntaks, og må alltid ligge helt øverst i filene, dvs uten noen blanke linjer foran. Front matter seksjonen settes opp mellom to --- linjer, og mellom disse, defineres ulike YAML variabler.

Eksempel:

---
title: Om Elma
description: elma legg inn beskrivelse
permalink: elma_index.html
sidebar: main_sidebar
product: elma
---

Parametrene "title" og "produckt" i Front matter styrer det som legger seg i navnet på sida (med | som skille) Verdien i "title" blir skrevet først på sida, der etter verdien i "summary"

{:toc}

skriver innholdsliste med overskrift "Innhold" først

For å vise verdien av en front matter variabel, benytter Jekyll et språk som kalles Liquid.

Man kan vise verdien av en variabel ved å omgi den med to krøll-paranteser slik:

{{ title }}

Det er også mulig å bygge opp logiske utsagn (if-statement for eksempel)

{% if page.search == true %}
<li>{% include search.html %}</li>
{% endif %}
Clone this wiki locally