21.01 Obsidian Cheatsheet

Obsidian is a markdown viewer. It has a lot of nice features like graph view and things. To read the official markdown cheat-sheet, go here.

Obsidian Markdown Cheat Sheet

Properties

This is used to assign properties to your md document, and obsidian uses these to sort by tags etc.

Needs to be the first thing in your document.

---
tags: 
- documentation
- cheatsheet 
---

You can also add aliases and cssclasses, I don’t know what those are for:

---
tags:
  - documentation
  - cheatsheet
aliases:
cssclasses:
---

Inside of the Obsidian app, you can also add these in an other way:

1. Click the 3 dots inside your document.
2. Click + Add file property
3. Now it’s opened at the top of your document.

Internal Links

[[Page Title]] 
[[Page Title|Custom Link Text]]

Backlinks

[[^Backlink Title]]

Tags

#tag

Embedding Images and Files

![Alt text](obsidian://vault/path/to/file)

Transclusion

![[Embed File]]

Folded Text

<details> 
<summary>Click to expand</summary>  
 
Content goes here.  
 
</details>

Footnotes

Some text[^1].  
 
[^1]: Footnote content.

Mermaid Diagrams

	```mermaid 
	graph LR   
	A --> B   
	B --> C
	B --> D
	C --> D
	```

graph LR   
A --> B   
B --> C
B --> D
C --> D

Kanban Boards

pretty sure you need a plugin for this

	```kanban 
	# To Do 
	- Task 1 
	- Task 2  
	
	# In Progress 
	- Task 3 
	
	# Done 
	- Task 4 
	```

Table of Contents

pretty sure you need a plugin for this

[[toc]]

Templates

	```template
	Name:  
	Date: 
	```

These features are specific to Obsidian and may not be supported or have the same syntax in other Markdown editors. Make sure to check Obsidian’s documentation for any updates or additional features.

Search Queries

Search

Here is an more in-depth article.

Here is a big Obsidian Markdown Cheatsheet

```query
tag:#documentation OR tag:#article OR tag:#tutorial 
```

tag:#documentation OR tag:#article OR tag:#tutorial 

Link to original

Quartz hosting

headers

When using Headers, only the following show up in your sidebar Table of Contents menu:

# Biggest header
## medium header
### smaller header

If you add more #‘s, they won’t be shown in the table of contents. And I think only the medium and smaller headers are clickable.

Tags

The example below is only for mentioning tags in your documents. It won’t make your document show up when filtering on the tags.

Tags

#tag

Link to original

If you want your document to be filtered by tags use Properties:

Properties

This is used to assign properties to your md document, and obsidian uses these to sort by tags etc.

Needs to be the first thing in your document.

---
tags: 
- documentation
- cheatsheet 
---

You can also add aliases and cssclasses, I don’t know what those are for:

---
tags:
  - documentation
  - cheatsheet
aliases:
cssclasses:
---

Inside of the Obsidian app, you can also add these in an other way:

1. Click the 3 dots inside your document.
2. Click + Add file property
3. Now it’s opened at the top of your document.

Link to original

How to host

23.10 Hosting obsidian on the web

I host this vault with quartz. The docs are quite straightforward.

commands

I have to run the following command whenever there are changes. It has to be in the root of the folder.

npx quartz sync

The following command makes it run locally.

npx quartz build --serve

You might have to do an npm install the first time you try to build it.

notes

• The date at the top of an article: Mar 07, 2024, 1 min read in quartz in the date that you have last updated the vault, not the file specifically. The 1 min read is file specific.
• To give your # a description, create a folder in the main directory called tags. create a md file in here with the same name of the #, it will show the document when you navigate to the # in your quartz.
• To give a folder a description, create an index.md file. This file will be opened when navigating to a folder in quartz.
• The home page is the index.md in the main dir.
• in quartz.layout.ts you can change things like your graph, and website layout
• in quartz.config.ts you can change things like text and images, textcolor and fonts.
• At step “In your local Quartz, create a new file quartz/.github/workflows/deploy.yml.” they mean: /.github/workflows/deploy.yml, they assume that your main folder is called quartz.
• The icons are in the quartz/static directory.

Link to original