%% date:: [[2022-12-23]], [[2022-12-23]], [[2024-01-22]] %% # [[obsidian-playbook/Using Obsidian/02 Making Notes in Obsidian/Markdown|Markdown]] Markdown is a lightweight [[Markup languages|markup language]] used to display content on the web in a simple way. It's the most popular markup language because it's the easiest to get started with. Markdown has different "flavours" or implementations that are slightly different in syntax. [[Obsidian]] notes are based on Markdown and are saved as `.md` files. Almost every web site we use regularly is written at least partially in some form of HTML. The problem is that HTML looks like this-- not exactly the most friendly for reading OR writing. The format called Markdown was created as a more readable *and* writable alternative to HTML, but it isn't a direct replacement. Instead, it's kind of like another layer entirely: you write in something that looks pretty much like human prose, with minimal marks that format the text in some way. At some point, Markdown is *rendered*: this is what's happening when you switch from source mode to Live Preview in Obsidian. This is also what's happening when you blog-- all the major blogging platforms take Markdown text and convert it into HTML. So HTML is better for displaying formatted text online, but Markdown is better when you're writing and reading in plain, unformatted text. <iframe width="560" height="315" src="https://www.youtube.com/embed/5qRVquqRH0k" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> *From [[Obsidian for non-coders]].* ## Headings ```markdown # This is heading 1 ## This is heading 2 ### This is heading 3 ``` Looks like this: # This is heading 1 ## This is heading 2 ### This is heading 3 ## Creating and embedding links ### Link to Obsidian note ```markdown [[Readme]] ``` Looks like this: [[Obsidian Playbook Readme]] ### Link to note but with link text ```markdown [[Readme|This is the readme.]] ``` Looks like this: [[Obsidian Playbook Readme|This is the readme.]] ### Link to a public website ```markdown [Nicole](https://nicolevanderhoeven.com) ``` Looks like this: [Nicole](https://nicolevanderhoeven.com) ### Link to a section of a note ```markdown [[Readme#What's in this vault?]] ``` Looks like this: [[Obsidian Playbook Readme#What's in this vault?]] ### Link to paragraph in note: ```markdown [[Readme#^f21c74]] ``` Looks like this: [[Obsidian Playbook Readme#^f21c74]] ### Embed note or part of notes Same as the previous five, but add a `!` at the start like: ```markdown ![[Readme#^f21c74]] ``` Looks like this: ![[Obsidian Playbook Readme#^f21c74]] ## Formatting text ### Bold text ```markdown **super** important ``` Looks like this: **super** important ### Italicize text ```markdown *a little* important ``` Looks like this: *a little* important ### Strikethrough text ```markdown ~~not important~~ ``` Looks like this: ~~not important~~ ### Highlight text ```markdown ==Remember this== ``` Looks like this: ==Remember this== ### Add block quote ```markdown > Live long and prosper. ``` Looks like this: > Live long and prosper. ## Embed image in vault ```markdown ![[notebook.png]] ``` Looks like this: ![[icon-notebook.png]] ## Add horizontal rule ```markdown --- ``` Looks like this: --- ## List items (bulleted) ```markdown - Item 1 - Item 2 ``` Looks like this: - Item 1 - Item 2 ## List items (numbered) ```markdown 1. Item 1 2. Item 2 ``` Looks like this: 1. Item 1 2. Item 2 ## Add a checklist ```markdown - [ ] Process notes - [X] Finish book ``` Looks like this: - [ ] Process notes - [X] Finish book ## Add in-line code ```markdown Command: `git push` ``` Looks like this: Command: `git push` ## Add callout ```markdown > [!NOTE] Note > This is a note. ``` Looks like this: > [!NOTE] Note > This is a note. ## Add code block > ```python > print('Hello world') > ``` Looks like this: ```python print('Hello world') ``` ## Add a comment You can create a comment that spans over multiple lines: ``` %% This is a multi-line comment. %% ``` And that looks like this: %% This is a multi-line comment. %% You can also create a comment on a single line: ``` %% But this is a comment too. %% ``` And it looks like this: %% But this is a comment too. %% ## Add a footnote ```markdown ... as Ahrens says. [^ahrens] [^ahrens]: Ahrens, S.(2022). ``` Looks like this: ... as Ahrens says. [^ahrens] ## Related - [Formatting your notes](https://help.obsidian.md/How+to/Format+your+notes) - [[Criticisms of Markdown]] [^ahrens]: Ahrens, S.(2022).