Add chapter for references

Signed-off-by: trivernis <trivernis@protonmail.com>
main
trivernis 4 years ago
parent 549b098c8b
commit c4a89527a1
Signed by: Trivernis
GPG Key ID: DFFFCC2C7A02DB45

@ -1,7 +1,7 @@
# Configuration # Configuration
Some attributes of a Snekdown document can be controlled by using a configuration file. 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. as a configuration file by default. Multiple configurations are combined.

@ -49,6 +49,7 @@ With the provided metadata images can be manipulated:
|| `![Adjust Contrast](img/snek.png)[width=20% contrast=50]` || `![Adjust Contrast](img/snek.png)[width=20% contrast=50]`
The image manipulations can also be combined. The order of execution can not be changed. The image manipulations can also be combined. The order of execution can not be changed.

@ -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.

@ -45,6 +45,9 @@
<[chapters/imports.md] <[chapters/imports.md]
- - -
<[chapters/references.md]
- - - - - -
<[chapters/bibliography.md] <[chapters/bibliography.md]

Loading…
Cancel
Save