├── _config.yml
└── README.md
/_config.yml:
--------------------------------------------------------------------------------
1 | remote_theme: pages-themes/minimal@v0.2.0
2 | plugins:
3 | - jekyll-remote-theme
4 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Obsidian cheat sheet and shortcuts
2 | This repository contains all the basic cheatsheets you need to get started to make notes in [obsidian](https://obsidian.md/). If something's missing, add yours by raising an issue here. ^_^
3 |
4 | > I am using [Things theme](https://github.com/colineckert/obsidian-things) in the screenshots below.
5 |
6 | ### Quick Tips:
7 | - **To Search for a specific note**: Use Ctrl + P (Cmd + P on Mac).
8 | - **For Internal Links**: Use `[[note name]]` to create internal links to other notes.
9 | - **For External Links**: Use `[Text](URL)` to create external links.
10 | - **For Bullet Points**: Use `-`, `*`, or `1`.
11 | - **For Headings**: Use `#` (e.g., # Heading 1, ## Heading 2).
12 | - **For Code Blocks**: Wrap text in triple backticks `(```)`.
13 | - **For Embeds**: Use `![[note name]]` to embed another note in your current note.
14 |
15 |
16 |
17 | | Word Formatting, Lists & Blockquotes | Links, Code Blocks, Tables & Footnotes |
18 | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
19 | |  |  |
20 |
21 |
22 | ---
23 |
24 | ## Obsidian Markdown Syntax
25 |
26 |
27 | Quick Overview:
28 |
29 |
30 |
31 |
32 | ```
33 | Headers:
34 | # H1
35 | ## H2
36 | ### H3
37 | #### H4
38 | ##### H5
39 | ###### H6
40 |
41 | Emphasis:
42 | _italic text_
43 | **bold text**
44 | _**bold italic text**_
45 | ~~strikethrough text~~
46 | ==Highlights==
47 |
48 | Lists:
49 | Unordered -
50 | - Item 1
51 | - Item 2
52 | Ordered -
53 | 1. Item 1
54 | 2. Item 2
55 |
56 | > This is a blockquote.
57 |
58 | Horizontal Line / Separator: ---
59 |
60 | Links:
61 | [link text](https://example.com/)
62 |
63 | Images:
64 | 
65 |
66 | Code:
67 | Inline - `code`
68 | Block -
69 | ```
70 | code
71 | ```
72 |
73 | Tasks
74 | - [x] Task completed
75 | - [ ] Task not completed
76 |
77 | > Quotes/ Blockquotes
78 |
79 | [^1]: footnote
80 | ```
81 |
82 | Detailed Overview:
83 |
84 |
85 | # Heading 1:
86 |
87 | ```
88 | # Heading 1
89 | ```
90 |
91 |
92 | ## Heading 2:
93 |
94 | ```
95 | ## Heading 2
96 | ```
97 |
98 | **Line Break**:
99 |
100 | ```
101 | ---
102 | ```
103 |
104 | - Bullet Points:
105 |
106 | ```
107 | - Bullet
108 | ```
109 |
110 | 1. Numbered List:
111 |
112 | ```
113 | 1. one
114 | 2. two
115 | ```
116 |
117 | - [X] Checklist:
118 |
119 | ```
120 | - [x] list
121 | ```
122 |
123 | **Bold**:
124 |
125 | ```
126 | **text**
127 | ```
128 |
129 | *Italic*:
130 |
131 | ```
132 | *text*
133 | ```
134 |
135 | ***Italic Bold***:
136 |
137 | ```
138 | ***text***
139 | ```
140 |
141 | ~~Strikethrough~~:
142 |
143 | ```
144 | ~~this text is crossed out~~
145 | ```
146 |
147 | Highlights:
148 |
149 | ```
150 | ==this text is highlighted==
151 | ```
152 |
153 |
154 | **```Code Blocks```**:
155 |
156 | ```
157 | By putting 3 (```) signs before and after the code.
158 | ``` code ```
159 | ```
160 |
161 | **[[Links]]**:
162 |
163 | ```
164 | [link](sources)
165 | ```
166 |
167 | Images:
168 |
169 | ```
170 | 
171 | ```
172 |
173 | Blockquotes:
174 |
175 | > Quotes/ Blockquotes
176 |
177 | ```
178 | > this is a quote.
179 | ```
180 |
181 |
182 | Tables:
183 |
184 | | Table Cell A | Table Cell B |
185 | | ------------ | ------------ |
186 | | Text | Text |
187 |
188 |
189 | ```
190 | | Table Cell A | Table Cell B |
191 | | ------------ | ------------ |
192 | | Text | Text |
193 | ```
194 |
195 | Tables with Alignment:
196 |
197 | | Left Align | Center Align | Right Align |
198 | | :--------- | :----------: | ----------: |
199 | | Text | Text | Text |
200 |
201 | ```
202 | | Left Align | Center Align | Right Align |
203 | | :--------- | :----------: | ----------: |
204 | | Text | Text | Text |
205 |
206 | ```
207 |
208 | Footnotes (like this[^1]):
209 |
210 | ```
211 | [^1]: This is the footnote you usually add at the bottom of your notes.
212 | ```
213 | [^1]: This is a footnote.
214 |
215 |
216 |
217 | These are super handy for big markdown files!
218 | Collapsible Sections (Click to expand):
219 |
220 |
221 |
222 | ```
223 |
224 | Toggle to Expand
225 | hidden content
226 |
227 | ```
228 |
229 | **Callouts**:
230 | ```
231 | > [!note]
232 | > This is a note callout.
233 |
234 | > [!tip]
235 | > This is a tip callout.
236 |
237 | > [!warning]
238 | > Be careful with this.
239 | ```
240 |
241 | For a comprehensive guide on callouts, see [Obsidian’s official documentation](https://help.obsidian.md/Callouts).
242 |
243 |
244 |
245 | **Emoji**:
246 |
247 | By default, Obsidian does not support `:emoji:` shortcodes. To use them, you can install this awesome community plugin: [Emoji Shortcodes](https://github.com/phibr0/obsidian-emoji-shortcodes).
248 |
249 |
250 | **Input:** `:smile: :rocket: :tada:`
251 |
252 | **Output:**: 😀🚀🎉
253 |
254 | ---
255 |
256 |
257 | ## Obsidian Shortcuts
258 |
259 | General Shortcuts:
260 |
261 |
262 |
263 | | Shortcut (Win/Linux) | Shortcut (Mac) | Function |
264 | | -------------------- | ------------------ | ---------------------------- |
265 | | Ctrl + S | Cmd + S | Save the file |
266 | | Ctrl + N | Cmd + N | Create a new note |
267 | | Ctrl + P | Cmd + P | Open command palette |
268 | | Ctrl + O | Cmd + O | Open quick switcher |
269 | | Ctrl + Shift + F | Cmd + Shift + F | Search in all files |
270 | | Ctrl + G | Cmd + G | Open graph view |
271 | | Ctrl + Alt + ← | Cmd + Alt + ← | Navigate back |
272 | | Ctrl + Alt + → | Cmd + Alt + → | Navigate forward |
273 | | Ctrl + F | Cmd + F | Search in current file |
274 | | Ctrl + H | Cmd + H | Find/Replace in current file |
275 | | Ctrl + E | Cmd + E | Toggle edit/preview modes |
276 | | Ctrl + , | Cmd + , | Open settings |
277 | | Ctrl + Tab | Ctrl + Tab | Next tab |
278 | | Ctrl + Shift + Tab | Ctrl + Shift + Tab | Previous tab |
279 | | Alt + Tab | Cmd + Tab | Next app |
280 | | Alt + Shift + Tab | Cmd + Shift + Tab | Previous app |
281 | | Win + Tab | Mission Control | Task view |
282 | | Win + Shift + Tab | Mission Control | Next window |
283 |
284 |
285 |
286 | Editing Shortcuts:
287 |
288 |
289 |
290 | | Shortcut (Win/Linux) | Shortcut (Mac) | Function |
291 | | -------------------- | ------------------- | ------------------------- |
292 | | Ctrl + B | Cmd + B | Bold selected text |
293 | | Ctrl + I | Cmd + I | Italicize selected text |
294 | | Ctrl + K | Cmd + K | Insert external link |
295 | | Ctrl + ] | Cmd + ] | Indent |
296 | | Ctrl + [ | Cmd + [ | Unindent |
297 | | Ctrl + D | Cmd + D | Delete current line |
298 | | Ctrl + V | Cmd + V | Duplicate current line |
299 | | Ctrl + Click | Cmd + Click | Open note in current pane |
300 | | Ctrl + Shift + Click | Cmd + Shift + Click | Open note in new pane |
301 | | Ctrl + P | Cmd + P | Quick search |
302 | | Ctrl + N | Cmd + N | New note |
303 | | Ctrl + Shift + D | Cmd + Shift + D | Create a daily note |
304 | | Ctrl + / | Cmd + / | Toggle command palette |
305 | | Ctrl + E | Cmd + E | Open graph view |
306 |
307 |
308 |
309 | Hope this helps you get more out of Obsidian!
310 |
311 |
312 |
--------------------------------------------------------------------------------