From 5e76fab44bca89c745f689048a5a04d71c7213ab Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 10 May 2017 21:48:22 +0100 Subject: [PATCH] Add docs for inner linking --- docs/markdown.md | 11 +++++++++++ test-files/2-pandoc.md | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/markdown.md b/docs/markdown.md index 46d456d..c5a14aa 100644 --- a/docs/markdown.md +++ b/docs/markdown.md @@ -12,3 +12,14 @@ Images take the same syntax as with standard markdown: Referencing files inside your project directory can be done with a path relative to the project directory. You can use images direct from online, however you'll need to be connected to the internet when generating. The title for the image is also used as the caption, and is displayed directly under the images. + + +### Linking +You can link to other parts of your document by their titles, in the same way linking to ids works on the web. + + +For example, if you had a title _Some Title_, then you can link to it like: + + [Click Here!](#some-title) + +__Note__: The header size doesnt matter. You link to an h4 tag the same as linking to an h1. diff --git a/test-files/2-pandoc.md b/test-files/2-pandoc.md index 08d5e36..e248668 100644 --- a/test-files/2-pandoc.md +++ b/test-files/2-pandoc.md @@ -1,4 +1,4 @@ - +### Referencing test - [@nonexistent]