From c4a89527a1b53585981e1f16f39e93136d04579a Mon Sep 17 00:00:00 2001 From: trivernis Date: Sun, 24 Jan 2021 19:23:03 +0100 Subject: [PATCH] Add chapter for references Signed-off-by: trivernis --- chapters/configuration.md | 2 +- chapters/images.md | 1 + chapters/references.md | 28 ++++++++++++++++++++++++++++ main.md | 3 +++ 4 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 chapters/references.md diff --git a/chapters/configuration.md b/chapters/configuration.md index 6035f7d..ba7c44f 100644 --- a/chapters/configuration.md +++ b/chapters/configuration.md @@ -1,7 +1,7 @@ # Configuration Some attributes of a Snekdown document can be controlled by using a configuration file. -The default name for this file is `Manifest.toml`. When importing a `toml` file, it gets interpreted +The default name of this file is `Manifest.toml`. When importing a `toml` file, it gets interpreted as a configuration file by default. Multiple configurations are combined. diff --git a/chapters/images.md b/chapters/images.md index f19fba0..ed4c07f 100644 --- a/chapters/images.md +++ b/chapters/images.md @@ -49,6 +49,7 @@ With the provided metadata images can be manipulated: || `![Adjust Contrast](img/snek.png)[width=20% contrast=50]` + The image manipulations can also be combined. The order of execution can not be changed. diff --git a/chapters/references.md b/chapters/references.md new file mode 100644 index 0000000..abe240c --- /dev/null +++ b/chapters/references.md @@ -0,0 +1,28 @@ +# References + +You can create anchors and references to anchors inside of snekdown documents with the following syntax: + + + +Anchor: `[?KEY]` + + +*renders as* + + +[?TestRef] + + + +Reference: `[Description](#KEY)` (classic url syntax) + + +*renders as* + + +[Description](#TestRef) + + + +Anchors don't render in the document but References to anchors do. +There's currently no validation if a reference is valid so make sure to use the correct keys. diff --git a/main.md b/main.md index 3285443..dff24ba 100644 --- a/main.md +++ b/main.md @@ -45,6 +45,9 @@ <[chapters/imports.md] +- - - +<[chapters/references.md] + - - - <[chapters/bibliography.md]