From b53e0945ecc497e03f39bf726075a512352f84b3 Mon Sep 17 00:00:00 2001 From: Ian Valentin Christensen Date: Wed, 26 Jun 2024 14:29:48 +0200 Subject: write overview of Markdown --- tools/markdown/index.qmd | 29 +++++++++++++++++++++++++++++ tools/markdown/neovim_example.png | Bin 0 -> 181215 bytes tools/markdown/report_example.png | Bin 0 -> 119151 bytes 3 files changed, 29 insertions(+) create mode 100644 tools/markdown/index.qmd create mode 100644 tools/markdown/neovim_example.png create mode 100644 tools/markdown/report_example.png (limited to 'tools/markdown') diff --git a/tools/markdown/index.qmd b/tools/markdown/index.qmd new file mode 100644 index 0000000..dd02c8b --- /dev/null +++ b/tools/markdown/index.qmd @@ -0,0 +1,29 @@ +--- +--- + +# Markdown + +Skrivningen af vores projektrapport sker i opmærkningssproget Markdown, +hvorefter selve rapporten dannes med Quarto. + +![Tekststykke i Neovim](neovim_example.png) + +Ovenfor ses den oprindelige kildetekst i Markdown, +som Quarto benytter for at rendere den endelige rapport. +Tekststykket anvender flere funktionaliteter for at danne den endelige rapport, +som ser ud som nedenstående. + +![Renderingen af den endelige rapport](report_example.png) + +Interne kommentarer omsluttes af "", +og disse vises ikke i den færdige tekst. +I eksemplet bruges Neovim som editor, +som vha. plugins og indbygget funktionalitet farvelægger særlig opmærkning. +Tekststykket er indrykket vha. vinkelbeslag, +hvor flere vinkelbeslag indrykker teksten yderligere. + +Den mest interassente funktionalitet er kildehenvisningen, +som sker ved firkantede parenteser, snabel-a +og et selvvalgt ID som udtrykkes i kildelisten. +I den endelige rapport er kildehenvisningerne interaktive, +så brugeren kan se dem i kildelisten ved at trykke på dem. diff --git a/tools/markdown/neovim_example.png b/tools/markdown/neovim_example.png new file mode 100644 index 0000000..41eaa01 Binary files /dev/null and b/tools/markdown/neovim_example.png differ diff --git a/tools/markdown/report_example.png b/tools/markdown/report_example.png new file mode 100644 index 0000000..1191a7a Binary files /dev/null and b/tools/markdown/report_example.png differ -- cgit v1.2.3