https://github.com/0qln/zettelkasten.obsidian
An obsidian configuration for a Zettelkasten-ish system.
https://github.com/0qln/zettelkasten.obsidian
config obsidian obsidian-theme obsidian-vault zettelkasten zettelkasten-methodology
Last synced: about 2 months ago
JSON representation
An obsidian configuration for a Zettelkasten-ish system.
- Host: GitHub
- URL: https://github.com/0qln/zettelkasten.obsidian
- Owner: 0qln
- Created: 2025-03-19T09:56:21.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-26T15:16:13.000Z (about 2 months ago)
- Last Synced: 2025-04-26T16:25:43.509Z (about 2 months ago)
- Topics: config, obsidian, obsidian-theme, obsidian-vault, zettelkasten, zettelkasten-methodology
- Homepage:
- Size: 4.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zettelkasten Obsidian configuration
This repository is an obsidian configuration, enabling you to have fun while filling your [Zettelkasten](https://zettelkasten.de/introduction/)! :D
Feel free to fork and cusomize your personal Zettelkasten.
If you prefer to not use the individual components, because it might seem like overengineering, you can select the [monolith branch](https://github.com/0qln/Zettelkasten.obsidian/tree/monolith).
## Components
Different components are seperated into their own repositories:
- [git](https://github.com/0qln/git.obsidian): Backups and version control
- [keys](https://github.com/0qln/keys.obsidian): Key bindings and Vim configuration
- [appearance](https://github.com/0qln/appearance.obsidian): Background image, color theme, etc.
- [zettelkasten-bundle](https://github.com/0qln/zettelkasten-bundle.obsidian): Zettelkasten specific plugins (e.g. templates, footnotes)
This is such that you can decide which modules you want, and that the version controls don't clutter each other:
Don't want vim bindings? Don't include the keys repository.
Don't want the default appearance? Create your own repository or fork the default one.
etc.
You can use the components in other vaults as well. e.g. the [appearance](https://github.com/0qln/appearance.obsidian) component, has nothing to do with the Zettelkasten mythology in itself.
The .obsidian-setup repository contains a helper script for setting up symlinks and copies.
## File tree
The file structure will look something like this:
```
MyZettelkasten/
├── .obsidian/
│ └── ...
├── Notes/
│ ├── note-1742392401394.md
│ └── note-1742403634777.md
├── Canvas/
│ ├── Global.canvas
│ ├── MyProject.canvas
│ └── MyOtherProject.canvas
├── Resources/
│ ├── capybara-image-yaay.png
│ └── interesting-paper.pdf
└── Templates/
└── Note.md
```
### Notes
Your notes will be placed here. For the notes, we don't use traditional naming systems, since the purpose of that traditional system was to enable linking (and a little tagging), which Obsidian can do natively.
Note, that you will want to create notes by:
- Opening the global search bar
- Typing in the name of your note
- Pressing `Shift + Enter`
This way the new note will automatically be placed into the `Notes/` folder and [Templater](https://github.com/SilentVoid13/Templater) will activate correctly:
### Canvas
Here you will be able to arrange markdown notes, just like analog ones.
### Resources
This is where files that your notes link to (e.g. images, PDFs) will be placed.
### Templates
The Templates for your notes. The Node.md template will be generated upon executing the setup script.
## Usage
**Prerequisits**: Python
**Installation**:
1. Clone the contents into your .obsidian folder:
```
git clone --recurse-submodules https://github.com/0qln/Zettelkasten.obsidian Path/to/myVault/.obsidian
```
2. Execute the [.obsidian-setup/setup.py script](https://github.com/0qln/.obsidian-setup):
```
py Path/to/myVault/.obsidian/.obsidian-setup/setup.py
```