Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tuan3w/obsidian-template

Starter templates for Obsidian
https://github.com/tuan3w/obsidian-template

note-taking obsidian obsidian-md obsidian-template productivity second-brain templates zettelkasten

Last synced: 26 days ago
JSON representation

Starter templates for Obsidian

Awesome Lists containing this project

README 

        
# Obsidian-template



- [Obsidian-template](#obsidian-template)

	- [Motivation](#motivation)

	- [What is inside this template ?](#what-is-inside-this-template-)

		- [Theme](#theme)

		- [Templates](#templates)

		- [Extensions](#extensions)

		- [Taking notes tips](#taking-notes-tips)

			- [1. Creating notes](#1-creating-notes)

			- [2.Review a topic/notes](#2review-a-topicnotes)

			- [3. Track your reading](#3-track-your-reading)

			- [4. Naming file](#4-naming-file)

			- [5. Anki card](#5-anki-card)

			- [6. Hot keys](#6-hot-keys)

			- [7. Pre-commit](#7-pre-commit)

			- [8. Auto note organizer](#8-auto-note-organizer)

			- [9. Automatic gather our ideas](#9-automatic-gather-our-ideas)

			- [10. Stats tracking (optional)](#10-stats-tracking-optional)

			- [11. Question documents with Khoj](#11-question-documents-with-khoj)

		- [Screenshots](#screenshots)

	- [FAQs](#faqs)

	- [License](#license)



## Motivation



I started new note-taking method after reading an interesting post about Zettelkasten method in [Hacker News](https://news.ycombinator.com/item?id=25803132). For many years, I was struggling about how to organizing my reading list as well as what I learned. I tried many tools & approaches like using Pocket, using browser bookmark, Medium, Trello, Twitter likes,... Nothing has worked. I kept forgetting about what I has read. Our memory isn't reliable as we might think. Building Second Brain idea has changed the way I learn. Obsidian is my favorite tool to build it. I keep changing how I get the most out of Obsidian.



I would love to share my templates with others, who are interested in learning and want to organizing your learning process better.

## What is inside this template ?

### Theme

- [Obsidian minimal](https://github.com/kepano/obsidian-minimal)

### Templates

There are various templates I often use that you can find in [templates folder](templates).

- `Term` : can be used to define specific term. should be short, simple, atomic.

- `Resource`: A type of entry notes about any topic, contains many related terms, links about one topic. You can use this as an entry points to explore other concepts in a topic.

- `Quote File`: Quote said by famous people.

- `Create Anki Card`: Used to mark a card as anki card. See more details in section bellow.

- `ID`: Generate unique Zettelkasten ID for current note.

- `Book`: Summary about a book.

- `Thought`: used to capture my ideas.

- ...

### Extensions

- [Templater](https://github.com/SilentVoid13/Templater): Template plugin for obsidian

- [Outliner](https://github.com/vslinko/obsidian-outliner): Work with your lists like Workflowy

- [Emoji Shortcodes](https://github.com/phibr0/obsidian-emoji-shortcodes) : to add new icon to your notes.

- [Style Settings](https://github.com/mgmeyers/obsidian-style-settings): Custom style

- [Kanban](https://github.com/mgmeyers/obsidian-kanban): To manage your reading list.

- [Spaced Repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition): to create anki cards .

- [Advanced Tables](https://github.com/tgrosinger/advanced-tables-obsidian): Edit table

- [Note Refactor](https://github.com/lynchjames/note-refactor-obsidian): Refactor notes

- [Dictionary](https://github.com/phibr0/obsidian-dictionary): Dictionary app

- [Cycle through Panes](https://github.com/phibr0/cycle-through-panes): Cycle through your open Panes

- [Contextual Typography](https://github.com/mgmeyers/obsidian-contextual-typography): Adjust typography styling

- [Linter](https://github.com/platers/obsidian-linter): Fix format errors

- [Calendar](https://github.com/liamcain/obsidian-calendar-plugin)

- [Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin)

- [Smart Random Note](https://github.com/erichalldev/obsidian-smart-random-note) : Random visit notes from your search result.

- [Tag Wrangler](https://github.com/pjeby/tag-wrangler): rename, merge, search tags from Obsidian tag pane.

- [Dataview](https://github.com/blacksmithgu/obsidian-dataview/): Creates automatic lists, tables from our notes.

- [Homepage](https://github.com/mirnovov/obsidian-homepage): Custom your home page.

- [Auto Note Mover](https://github.com/farux/obsidian-auto-note-mover): Auto organize notes by tags.

- [Khoj](https://github.com/khoj-ai/khoj): An AI copilot for your second brain. Search and chat with your personal knowledge base, online or offline.



### Taking notes tips

#### 1. Creating notes

- Create new Zettelkasten notes when you want to take note about new thing by hot key `Ctrl+N` and pick a template by using hot key `Ctrl+T`

- For books, you might want to add [link to local file](https://forum.obsidian.md/t/how-to-link-a-local-file-in-obsidian/5815) so that you can open book from your note quickly.

- If you want to add content later, just add a `todo` tag in the front matter.

- The note is formatted every time you save your note, thanks to linter plugin.

#### 2.Review a topic/notes



- Notes are organized by topics. Open search and search for tag you want to review. Press `Ctrl+Tab` to view a random note from your search result.

- Any new note should add a `review` tag and remove it as soon as you think it's good enough. To visit a note that need to be reviewed, enter `Ctrl+R` or exec command `Spaced Repetition: Open a note for review`.



#### 3. Track your reading



- I created two Kanban boards to track my regular reading and book reading. I think it really helps when you have multiple things in your reading list. Again, don't trust your memory.



#### 4. Naming file



- One tip I regularly find useful is adding type of notes in the file name to make them clear, so you can navigate file later easier. For example:

	- Resource notes: `(Resource) Topic name`

	- Kanban board: `(Kanban) Books`

	- Book: `(Book) product`

#### 5. Anki card



- Overtime, you will create new cluster of knowledge. You might want to review this topic using better way than visiting them randomly. So [Anki is your friend](https://aliabdaal.com/spaced-repetition/). Creating new anki deck is simple enough:

	- Add new desk: Add tag about topic in [Spaced repetition plugin setting](https://github.com/st3v3nmw/obsidian-spaced-repetition). I prefer this approach more than turning folder name into deck name because it provides more better control.

	- Add new card: I only used [multiple-line card style](https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Flashcard-Types#multi-line-basic) . I choose `[ ](#anki-card)` as separator because it's invisible in preview mode. To add separator, just use template `Create Anki Card` to insert the separator after the first heading of the note. By default, `Term` card is an anki card.



#### 6. Hot keys



 I use a number of hot keys to make quick actions. You can see them in `Hotkeys` section in the setting.

#### 7. Pre-commit

You may want to compress your image files to keep them in control. In order to do this, you need to install pre-commit hook.

I use [oxipng](https://github.com/shssoichiro/oxipng) to compress images. So you need to have this package installed in your system. After that, just install pre-commit hook:

```bash

pre-commit install

```



#### 8. Auto note organizer



I use [Auto Note Mover](https://github.com/farux/obsidian-auto-note-mover) to auto organize my notes. It's really helpful when you have a lot of notes. Just add tag to your note and it will be moved to the folder you specify

in the plugin settings.

![Auto Note Mover](./screenshots/screenshot-3.png)



 #### 9. Automatic gather our ideas

 I use DataView plugin to create automatic list. For example, you can use DataView to gather all your ideas in one place. See [example](./notes/20210903091505%20-%20My%20thoughts%20(resource).md).

 However, the downside of this approach is that the all the links won't be displayed in graph view. So you might consider manual linking if you need that.

#### 10. Stats tracking (optional)

 I also provide some [script](./update_stats.py) to update your reading stats (how many notes you have taken over time). Everytime you want to update git, just run command:

 ```bash

 $ ./update your message without quote here

 ```



 It will add all the new notes, update note stats, generate a picture of your progress and create new commit with your message. Your stats will look like this:

 ![stats](stats.png)



#### 11. Question documents with Khoj



You may have many documents that you want to read, but not have time to review them yet. You can use [Khoj](https://github.com/khoj-ai/khoj) to search and chat with your documents. For example, when I want to read a paper, I will create a note with the paper attached inside the note.



### Screenshots



![img1](./screenshots/screenshot-1.png)



![preview-mode](./screenshots/screenshot-2.png)



## FAQs



If you wanted to know more about Zettelkasten method, I recommend book [How to Take Smart Notes: One Simple Technique to Boost Writing, Learning and Thinking – for Students, Academics and Nonfiction Book Writers](https://www.amazon.com/gp/product/1542866502/) as a good start.



Happy learning :).



## License



[MIT](LICENSE)