Skip to content

Commit

Permalink
Add a note about Obsidian (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
skatkov committed Sep 23, 2023
1 parent 02960c6 commit 3bad588
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- Instantly edit current day entry
- Journal using any plain-text format (txt, md, [xit](https://xit.jotaen.net/) or anything else)
- Basic templates support
- Works on Linux and OSX.
- Works on Linux and OSX
- Overview/filtering of existing entries

## Installation
Expand Down Expand Up @@ -50,6 +50,24 @@ t really need. Plain-text files stored in cloud storage and edited througn nano

Epictetus, great Stoic philospher and slave, once told to his students that "philosophy is something one should write down day by day". Hence name of this tool is a reference to this great human and hat tip to practical philosophy called Stoicism.

## Obsidian integration
I wrote this tool our of frustration with existing note taking apps (everything has to be in the cloud these days), but there are other apps that followed similar design choices as `stoic` did.

I'm now using [Obsidian](https://obsidian.md/) as a fully featured writing app. Obsidian comes with some core plugins that you can enable, one of those is "Daily Notes" that does something similar to `stoic`. Notherless I still keep using `stoic` as a companion cli app to Obisidian, with light configuration changes they play perfectly together.

With 0.6 version of stoic a lot of settings are aligned with those Obsidian defaults to. In my case, only two settings are tweaked:
```
export STOIC_DIR="~/Obsidian/journal"
export STOIC_TEMPLATE="~/Obsidian/journal/template.md"
```
This closely corresponds to settings I have in obsidian daily notes:
![obsidian daily notes config](./obsidian-daily-notes.png)


The only thing that stoic doesn't allow you to tweak is date format. So if you have that customized in obsidian - bad luck.

but PR's are welcome, everything is fixable.

## Development
As prerequisite, you need to have the [Go compiler](https://golang.org/doc/install).
Please check the [`go.mod`](go.mod) file to see what Go version stoic requires.
Expand Down
Binary file added obsidian-daily-notes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3bad588

Please sign in to comment.