Skip to content

Instantly share code, notes, and snippets.

@NotDefinedTech
Last active February 25, 2024 18:11
Show Gist options
  • Select an option

  • Save NotDefinedTech/ffa47f86dfe7d16f0300cf5de414a8a3 to your computer and use it in GitHub Desktop.

Select an option

Save NotDefinedTech/ffa47f86dfe7d16f0300cf5de414a8a3 to your computer and use it in GitHub Desktop.
Quick overview of markdown syntax and Obsidian linking

Headings

Use a # and a space at the beginning of a line to turn it into a heading. You can indicate which level of heading by how many # you use. If you're familiar with HTML, it's the same: H1 = #, H2 = ##, etc. up to 6 #

Example:

# Main Topic
...

## Sub Topic
...
### Sub-sub topic
...

## Sub Topic

Typographic Styles

Bold, italics, strikethroughs, inline code, and even code blocks are all available to you.

Bold, use two asterisks or the common keyboard combo: CTRL / CMD + B:

**Bold**

Italics, use one asterisk or the common keyboard combo: CTRL / CMD + I:

*Italics*

Strikethroughs, use two tildes:

~~strikethroughs~~

Inline code, use a back tick (same key as the tilde ~):

`inline code`

Code blocks, use three back ticks:

```(code language goes here) Code Block ```

==Highlights==, use two equal signs

==Highlights==

Links

There are two types of links: external and internal.

External Linking

An external link goes to a website or a file. for example: https://freakyfossils.com

You can simply paste a URL into the editor and it will pick up as a clickable link. If you want to change the link text so that it works inline, use the markdown syntax:

[change the link text](https://freakyfossils.com)

Internal Linking

This is the power of Obsidian! You can link your notes together with internal links. Use to square brackets to create a link to a note:

[[Obsidian Quick Start Guide]]

Inside of the brackets, you'll put the title of your note, but you can also change the text, in case you want to be able to [[Obsidian Quick Start Guide|link to a note]] inside of a paragraph/sentence. Use the pipe | character after the note title to change the link text:

[[Obsidian Quick Start Guide|link to a note]]

Embedded content from your notes is also possible with internal linking! Put a ! in front of your link to pull in the content from your linked note.

![[Obsidian Quick Start Guide]]

You can also choose just a specific heading of that link note to pull in a smaller section of content like this: ![[Obsidian Quick Start Guide#External Linking]]

![[Obsidian Quick Start Guide#External Linking]]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment