Jekyll Digital Garden Template Docs

To link to another note, you can use multiple syntaxes. The following four use the “double-bracket” notation (view the Markdown source file to see the underlying syntax).

  • Using the note title: [[ a note about cats ]]
  • Using the note’s filename: [[ cats ]]
  • Using the note’s title, with a label: [[ A note about cats|link to the note about cats using the note title ]]
  • Using the note’s filename, with a label: [[ cats|link to the note about cats using the note’s filename ]]

You can organize notes in subdirectories and link them normally. For example, the links above all point to the _notes/animals/ file. Here’s another example: [[ tigers ]].

Dashes and underscores in file names are supported, and may be omitted in the bracket link syntax. As an example, the file can be linked to with [[ your first note ]] or [[ your-first-note ]], or even [[ yOuR-FiRsT Note ]].

In all cases, if the double-bracket link does not point to a valid note, the double brackets will still be shown, like this: [[ there is no note that matches this link ]].

Alternatively, you can use regular Markdown syntax for links, with a relative link to the other note, like this: this is a Markdown link to the note about cats. Don’t forget to use the .internal-link class to make sure the link is styled as an internal link (without the little arrow).

Since the Web is all about HTML, you can always use plain HTML if you want, like this: This is a link to the note about cats with HTML.

Of course, you can also link to external websites, like this: this is a link to Wikipedia. Again, you can use plain HTML if you prefer. Footnotes are also supported and will be treated like internal links.1 You can point to other notes in your footnotes.2

Images and other Markdown goodies

Finally, because you have the full power of Markdown in this template, you can use regular Markdown syntax for various formatting options.

Lists work as expected:

  • List element A
  • List element B
  • List element C
  1. List element
  2. List element
  3. List element

If you’d like to quote other people, consider using quote blocks:

Lorem ipsum dolor sit amet

And of course, images look great:

You can also highlight some content by wrapping it with ==.

Code syntax highlighting

You can add code blocks with full syntax color highlighting by wrapping code snippet in triple backticks and specifying the type of the code (js, rb, sh, etc.):

// Here's a bit of JavaScript:
# And now some Ruby
def foo(bar)
$ cat /dev/urandom | grep "the answer to life" # shell scripts look nice too
  1. This is a footnote. For more information about using footnotes, check out the Markdown Guide

  2. This is another footnote that links to the note about [[ cats ]]. You may also point to [[ notes that do not exist ]] if you wish. 

Mentioned in