Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itzalak/obsidian-template
https://github.com/itzalak/obsidian-template
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/itzalak/obsidian-template
- Owner: itzalak
- Created: 2023-08-26T09:58:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-24T21:37:52.000Z (9 months ago)
- Last Synced: 2024-04-18T17:11:31.672Z (8 months ago)
- Language: Python
- Homepage:
- Size: 7.53 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Obsidian zettlekasten notes
## Table of contents
- [Introduction](#introduction)
- [Features](#features)
- [Structure](#structure)
- [Notes](#notes)
- [Community Plugins](#community-plugins)
- [Technologies](#technologies)
## Introduction
Obsidian is a flexible note taking app that allows me to use my current zettlekasten template and markdown type file to
save notes.
The goal is to use flexibly obsidian and zettlekasten to save notes and using a generic markdown file based on a defined
template and save it using a git repository.
Obsidian saves notes in
a [flavour of Markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown) format in a vault -
a directory - where it also stores all the configuration and plugins.
## Features
- Create zettlekasten style scratch notes based on [scratch](/templates/scratch-template.md) template, when note is
definitive it becomes a zettlekasten, and it is moved to `notes/zettlekasten`
- Write down and maintain a list project ideas, tasks, meeting notes, diagrams, etc, via templates. Details in the [[backlog/README|backlog readme]] - example notes exist under backlog directories for saving project views configuration.
- Curate important snippets like commands cheatsheets and cookbook actions under `notes` directory
- Configuration and template should be usable as markdown files outside of obsidian (TODO)
### Obsidian exclusive
- Book notes and management using book search plugin and dataview for presentation (not possible to maintain outside
obsidian)
## Structure
```shell
├── archive
├── bin
├── books
│ ├── The Clean Coder - Robert C Martin.md
│ ├── The Pragmatic Programmer - David Thomas Andrew Hunt.md
│ └── bookshelf.md
├── notes
│ ├── cheatsheet
│ ├── cookbook
│ ├── scratch
│ ├── tasks
│ └── zettlekasten
└── templates
├── book-template.md
├── cheatsheet-template.md
├── epic-template.md
├── meeting-template.md
├── scratch-template.md
└── task-template.md
```
## Notes
1. [Obsidian Markdown Flavour](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown) is different
from other common flavours and does not support full scope of features, some conflicts will occur when using
automation and when using other editors to change text
2. Obsidian allows dictionaries through community plugins, but they are limited by comparison to Grammarly or even
Jetbrains tools
3. Using git to sync the vault requires the use of `.gitkeep` files otherwise the directory structure will not be synced
4. The existent [pre-commit](/.pre-commit-config.yaml) requires the exclusion of the `.obsidian` directory to avoid
constant conflicts
5. Workspace configuration is excluded from git sync through `.gitignore` to prevent conflict
## Community Plugins
- [Templater](https://github.com/SilentVoid13/Templater)
- [Dataview](https://github.com/blacksmithgu/obsidian-dataview)
- [Commander](https://github.com/phibr0/obsidian-commander)
- [Quick Add](https://github.com/chhoumann/quickadd)
- [Projects](https://github.com/marcusolsson/obsidian-projects)
- [Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin)
- [Book Search](https://github.com/anpigon/obsidian-book-search-plugin)
- [Execute Code](https://github.com/twibiral/obsidian-execute-code)
- [Minimal Theme Settings](https://github.com/kepano/obsidian-minimal-settings)
### Others
Multiple other plugins not included that can be useful or interesting to include in obsidian workflow.
- [Calibre](https://github.com/caronchen/obsidian-calibre-plugin) - read and take notes using calibre server
- [Advanced slides](https://github.com/MSzturc/obsidian-advanced-slides) - markdown slides
- [Advanced tables](https://github.com/tgrosinger/advanced-tables-obsidian) - handle markdown tables
- [Kanban](https://github.com/mgmeyers/obsidian-kanban)
- [Annotator](https://github.com/elias-sundqvist/obsidian-annotator) - open and annotate pdf and epub files
## Technologies
- [Obsidian](https://obsidian.md/)
- [Zettlekasten](https://zenkit.com/en/blog/a-beginners-guide-to-the-zettelkasten-method/)