searchable-jekyll-template/_notes/your-first-note.md
Maxime Vaillancourt b4c05c2465 Improve first note
2020-11-22 13:03:28 -05:00

3.0 KiB

title, image
title image
Your first seed /assets/image.jpg

Welcome!

This is your first note. You'll find it in the notes/ directory.

To link to another note, you can use Roam/wiki-style link syntax by wrapping a note's title (as defined in the note's front matter) in double brackets, like this: a note about cats. You may also use the note's filename without the extension in the brackets, like this: cats. If the Roam-style link does not point to a valid note's title, the double brackets will still be shown, like this: there is no note with this title.

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{: .internal-link}. 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.

Notice in the "Notes mentioning this note" section that there is another note linking to this note. This is a bi-directional link, and those are automatically created when you create links to other notes.

If you're on a device with mouse support, try hovering your mouse on internal links to preview the notes: a note about cats.

Images and other Markdown goodies

Finally, because you have the full power of Markdown in this template, you can display images using regular Markdown syntax, like this:

Lists work as expected:

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

So do code blocks, with full syntax highlighting:

// Here's a bit of JavaScript:
console.log('hello!')

And if you'd like to quote other people, consider using quote blocks:

Lorem ipsum dolor sit amet

Next steps

If this template is useful to you in any way, consider donating to support my work.

This digital garden template is free, open-source, and available on GitHub here.

The easiest way to build your own digital garden based on this template is to read this step-by-step guide explaining how to set this up from scratch. If you need any help, my DMs are open on Twitter (@vaillancourtmax). 👋

Go forth, have fun, and learn new something every day! ✌️