aboutsummaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorIan Valentin Christensen <valentianchristensen@gmail.com>2024-06-26 14:29:48 +0200
committerIan Valentin Christensen <valentianchristensen@gmail.com>2024-06-26 14:32:35 +0200
commitb53e0945ecc497e03f39bf726075a512352f84b3 (patch)
tree50c13ab29f0cbaf4743809d284393f78c8e85c89 /tools
parent1c93945e4526104f291c7f335f237485649a7d4c (diff)
write overview of Markdown
Diffstat (limited to 'tools')
-rw-r--r--tools/markdown/index.qmd29
-rw-r--r--tools/markdown/neovim_example.pngbin0 -> 181215 bytes
-rw-r--r--tools/markdown/report_example.pngbin0 -> 119151 bytes
3 files changed, 29 insertions, 0 deletions
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 "-- >",
+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
--- /dev/null
+++ b/tools/markdown/neovim_example.png
Binary files differ
diff --git a/tools/markdown/report_example.png b/tools/markdown/report_example.png
new file mode 100644
index 0000000..1191a7a
--- /dev/null
+++ b/tools/markdown/report_example.png
Binary files differ