searchable-jekyll-template/_notes/your-first-note.md

64 lines
3.0 KiB
Markdown
Raw Normal View History

2020-05-19 22:59:37 -04:00
---
title: Your first seed
image: /assets/image.jpg
---
2020-07-21 21:05:19 -04:00
### Welcome!
2020-05-19 22:59:37 -04:00
2020-07-21 22:08:56 -04:00
This is your first note. You'll find it in the [`notes/`](https://github.com/maximevaillancourt/digital-garden-jekyll-template/tree/master/_notes) directory.
2020-05-19 22:59:37 -04:00
2020-07-21 21:05:19 -04:00
### Link syntax
2020-11-22 13:02:17 -05:00
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]].
2020-07-21 21:05:19 -04:00
2020-11-22 13:02:17 -05:00
Alternatively, you can use regular [Markdown syntax](https://www.markdownguide.org/getting-started/) for links, with a relative link to the other note, like this: [this is a Markdown link to the note about cats](/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).
2020-07-21 21:05:19 -04:00
2020-11-22 13:02:17 -05:00
Since the Web is all about HTML, you can always use plain HTML if you want, like this: <a class="internal-link" href="/cats">This is a link to the note about cats with HTML</a>.
2020-07-21 21:05:19 -04:00
2020-11-22 13:02:17 -05:00
Of course, you can also link to external websites, like this: [this is a link to Wikipedia](https://wikipedia.org/). Again, you can use plain HTML if you prefer.
2020-07-21 21:05:19 -04:00
### Automatic bi-directional links
2020-05-19 22:59:37 -04:00
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.
2020-07-21 21:05:19 -04:00
### Link previews
2020-11-22 13:02:17 -05:00
If you're on a device with mouse support, try hovering your mouse on internal links to preview the notes: [[a note about cats]].
2020-07-21 21:05:19 -04:00
2020-11-22 13:02:17 -05:00
### Images and other Markdown goodies
2020-07-21 21:05:19 -04:00
2020-11-22 13:02:17 -05:00
Finally, because you have the full power of Markdown in this template, you can display images using regular Markdown syntax, like this:
2020-05-19 22:59:37 -04:00
![]({{page.image}})
2020-07-21 21:05:19 -04:00
2020-11-22 13:02:17 -05:00
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:
```js
// 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
2020-07-21 21:05:19 -04:00
### Next steps
2020-11-22 13:02:17 -05:00
**If this template is useful to you in any way, consider [donating](https://ko-fi.com/maximevaillancourt) to support my work**. ☕
2020-07-22 06:58:27 -04:00
This digital garden template is free, open-source, and [available on GitHub here](https://github.com/maximevaillancourt/digital-garden-jekyll-template).
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](https://maximevaillancourt.com/blog/setting-up-your-own-digital-garden-with-jekyll). If you need any help, my [DMs are open on Twitter (@vaillancourtmax)](https://twitter.com/vaillancourtmax). 👋
2020-07-21 21:05:19 -04:00
Go forth, have fun, and learn new something every day! ✌️