From 9e1ec6497c12ae8f4f3b17f702f01f0077d87ef6 Mon Sep 17 00:00:00 2001 From: Daniel Kapitan Date: Sat, 30 Dec 2023 20:40:53 +0100 Subject: [PATCH] Update obsidian-setup.qmd Edits --- blog/obsidian-setup.qmd | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/blog/obsidian-setup.qmd b/blog/obsidian-setup.qmd index acbaa30..51bfb79 100644 --- a/blog/obsidian-setup.qmd +++ b/blog/obsidian-setup.qmd @@ -24,20 +24,20 @@ How to integrate [Calibre](https://calibre-ebook.com/), [Quarto](https://quarto. > > Increase motivation, energy, and work/life balance by making time for renewing activities. ~ _Stephen Covey_ -Keeping things organised and efficient is one of my basic needs. I helps me keep a clear mind and be productive. I have been using the [getting things done method](https://gettingthingsdone.com/what-is-gtd/) for over a decade now, and was one of the early adopters of [Todoist](https://todoist.com/home). In fact, at my current rate of 80 points per week, I expect to become Enlightened somewhere at the beginning of the upcoming [Year of the Dragon](https://en.wikipedia.org/wiki/Dragon_(zodiac)). +Keeping things organised and efficient is one of my basic needs. It helps me keep a clear mind and be productive. I have been using the [getting things done method](https://gettingthingsdone.com/what-is-gtd/) for over a decade now, and was one of the early adopters of [Todoist](https://todoist.com/home). In fact, at my current rate of 80 points per week, I expect to become Enlightened somewhere at the beginning of the upcoming [Year of the Dragon](https://en.wikipedia.org/wiki/Dragon_(zodiac)). ![My Karma points in Todoist at the end of 2023](images/todoist-karma.png){fig-align="left"} Beyond organising the things I need to do, I have been looking to sharpen my saw for reading and writing, both of which I do a lot. Also here, I switched to a fully digital workflow some years ago: my books now all live in [calibre](https://calibre-ebook.com/), I take notes on the [reMarkable 2](https://remarkable.com/) and do all of my writing in markdown. Over the years, I have tried many different apps: [Day One](https://dayoneapp.com/), [iA Writer](ia writer) and even a bare-bones code editor with a GitHub repository hosting a [MkDocs](https://www.mkdocs.org/) site. -But I was never quite satisfied with any of these setups. To address my note-taking needs whilst reading, I tried different tablets with digital pens, but found none of these worked for me because I could not easily get my highlights and notes into my workflow. But I also prefer to read on a passive, e-ink screen which is why I tried the reMarkable mark I when it first came out. Alas, I quickly returned that one, but send it back because it lacked the integrations I needed. And when writing content for my lectures, I found myself spending lots of time looking up quotes and references that I had read somewhere. I also found there was just too much friction in getting something published from my note-taking app using a different tool. +But I was never quite satisfied with any of these setups. To address my note-taking needs whilst reading, I tried different tablets with digital pens, but found none of these worked for me because I could not easily get my highlights and notes into my workflow. I also prefer to read on a passive, e-ink screen which is why I tried the reMarkable mark I when it first came out. Alas, I quickly returned that one because it lacked the integrations I needed. So here I am, still spending lots of time looking up quotes and references that I had read somewhere when writing content for my lectures. And on top of that there is the additional friction of getting my markdown notes into my publishing workflow. Surely, in this day and age there must be a better way in which we can use digital tools to support our reading, thinking and writing? Surely I should be able to render a website, a pdf - even a Word document if a clients asks for it - using the same markdown content? And indeed, it seems that as of 2022 a number of tools have delivered on the promise of supporting a smooth, fully digital workflow for reading, thinking and writing. In my case, I chose [Obsidian](https://obsidian.md/) and [Quarto](https://posit.co/blog/announcing-quarto-a-new-scientific-and-technical-publishing-system/) as the core components.[^alternatives] ## Obsidian, arguably the most flexible note-taking app Obsidian arguably is the most flexible note-taking app out there. The key differentiating feature for me is its ability to create graphs of interlinked notes, thereby natively supporting [Andy Matuschak's Evergreen note-taking concept](https://notes.andymatuschak.org/Evergreen_notes). Its vibrant community, with over 1,370 contributed plugins at the time of writing is also a boon, which allows me to integrate it with my other tools. -The diagram below shows how I have integrated Calibre and Obsidian for use on my MacBook, Pixel 5 Android phone and reMarkable 2. [Syncthing](https://syncthing.net) does the heavy lifting of keeping my markdown notes and ebooks in sync across multiple devices. That way, I have maximal control with the least amount of lock-in. Incidentally, my Calibre library is also synced to my NAS, with an additional backup to Google Drive which serves as my primary storage platform. Note that this setup work for any combination of {Linux | OSX | Windows} desktops and {iOS | Android} smartphones, as all the apps are cross-platform.[^reader] +The diagram below shows how I have integrated calibre and Obsidian for use on my MacBook, Pixel 5 Android phone and reMarkable 2. [Syncthing](https://syncthing.net) does the heavy lifting of keeping my markdown notes and ebooks in sync across multiple devices. That way, I have maximal control with the least amount of lock-in. Incidentally, my calibre library is also synced to my NAS, with an additional backup to Google Drive which serves as my primary storage platform. Note that this setup work for any combination of {Linux | OSX | Windows} desktops and {iOS | Android} smartphones, as all the apps are cross-platform.[^reader] ```{.d2 theme="NeutralGrey" layout="elk" sketch=true caption="How to integrate Calibre, Obsidian and reMarkable 2 using Syncthing"} @@ -151,19 +151,19 @@ scrybble -- MacBook.Obsidian.scrybble ### Easier to read, think and take notes With this setup, taking notes while reading books on my smartphone already is a lot easier. Using Moon+ Reader, I can just highlight texts, copy and paste it directly into Obsidian. For longer reads on my reMarkable, is have setup [scrybble](https://scrybble.ink/) to sync notes to Obsidian. This Amsterdam-based startup (yay!) is still quite young, and the functionality is still basic so am awaiting eagerly future releases. -When I am at the desk, I can now do all of my reading and note-taking in Obsidian thanks to the [calibre plugin](https://github.com/caronchen/obsidian-calibre-plugin). After tinkering with the configuration, I found it so blissful being able to read, think and write from a single application. No distractions! Also, now I can gradually ease into the Evergreen way of note-taking to structure my thinking. Opening a linked note using `Cmd+T` with the __stack notes__ option turned on, just adds to the joy of working like this: +When I am at the desk, I can now do all of my reading and note-taking in Obsidian thanks to the [calibre plugin](https://github.com/caronchen/obsidian-calibre-plugin). After tinkering with the configuration, I found it so blissful being able to read, think and write from a single application. No distractions! Also, now I can gradually ease into the Evergreen way of note-taking to structure my thinking. Opening a linked note using `Cmd+T`, with the __stack notes__ option turned on, just adds to the joy of working like this: ![](https://user-images.githubusercontent.com/693981/188205363-0f24b2a5-3706-4a8c-b38b-7a66baa68ce6.gif) ### Easier to write and publish -Further down into the workflow, I can now write and publish from Obsidian, too. This paper in fact served as a challenge-based learning project of sorts to do exactly that. Drawing diagrams with [d2](https://d2lang.org) is supported thanks to the [official plugin](https://github.com/terrastruct/d2-obsidian). And I could in fact publish a static site directly on, say, GitHub pages from Obsidian as well using the [Obsidian Git plugin](https://github.com/denolehov/obsidian-git). I find, however, that the Quarto engine is the better tool for my publishing needs. +Further down into the workflow, I can now write and publish from Obsidian, too. This paper in fact served as a challenge-based learning project of sorts to do exactly that. Drawing diagrams with [d2](https://d2lang.org) is supported thanks to the [official plugin](https://github.com/terrastruct/d2-obsidian). I could also publish a static site directly on, say, GitHub pages from Obsidian as well using the [Obsidian Git plugin](https://github.com/denolehov/obsidian-git). I find, however, that the Quarto engine is the better tool for my publishing needs. ## Quarto for a streamlined publication workflow -My work as a data scientist and architect relies extensively on code and data analysis. Python-based notebooks have long provided the capability of merging the paper narrative, the computational code powering the analysis, and the summary plots into a reproducible report. Quarto supports all of this into a streamlined publication workflow that lowers the adoption barrier of the [__"docs as code"__](https://www.writethedocs.org/guide/docs-as-code/) paradigm. With a single command, the notebook text sources (narrative and code) are transformed into a polished publication-ready article in a variety of formats, be it a PDF or dynamic HTML page enabling the reader to interact with the data tables and plots. Even without its discerning feature of publishing executable notebooks, I found the otuput crisp and professional. Earlier this year, I decided to go all out on Quarto, and redesigned my [company website](https://github.com/dkapitan/dkapitan.github.io) with it. +My work as a data scientist and architect relies extensively on code and data analysis. Python-based notebooks have long provided the capability of merging the paper narrative, the computational code powering the analysis, and the summary plots into a reproducible report. Quarto supports all of this into a streamlined publication workflow that lowers the adoption barrier of the [__"docs as code"__](https://www.writethedocs.org/guide/docs-as-code/) paradigm. With a single command, the notebook text sources (narrative and code) are transformed into a polished publication-ready article in a variety of formats, be it a PDF or dynamic HTML page enabling the reader to interact with the data tables and plots. Even without its discerning feature of publishing executable notebooks, I found the output crisp and professional. Earlier this year, I decided to go all out on Quarto, and redesigned my [company website](https://github.com/dkapitan/dkapitan.github.io) with it. ![source: [Gaël Close](https://gael-close.github.io/posts/2209-tech-writing/2209-tech-writing.html).](images/quarto-workflow.png) -In the current setup, I could easily copy a markdown file from my Obsidian journal into my Quarto website project. As always, though, there is some friction having switch between the different flavours of markdown. For example, compare the syntax for callouts in Quarto vs. Obsidian: +In the current setup, I could easily copy a markdown file from my Obsidian journal into my Quarto website project. Some friction remains, though, having to switch between the different flavours of markdown. For example, compare the syntax for callouts in Quarto vs. Obsidian: ::: {layout-ncol=2} @@ -186,7 +186,7 @@ Main text goes here. ::: -Despite these inconveniences, I will conclude with this advice for the coming year: give a markdown-based workflow a try. And if you like the setup described hear, make sure to donate and support [calibre](https://calibre-ebook.com/donate), [Obsidian](https://help.obsidian.md/Licenses+and+payment/Catalyst+license) and [Syncthing](https://syncthing.net/donations/) - besides getting yourself a classy e-ink reader 😉. +Despite these inconveniences, I will conclude with this advice for the coming year: give an end-to-end markdown-based workflow a try. And if you like the setup described hear, make sure to donate and support [calibre](https://calibre-ebook.com/donate), [Obsidian](https://help.obsidian.md/Licenses+and+payment/Catalyst+license) and [Syncthing](https://syncthing.net/donations/) - besides getting yourself a classy e-ink note-taking device 😉. [^alternatives]: There are alternative [markdown note-taking apps](https://github.com/tehtbl/awesome-note-taking), and in theory you can use any [static site generator that support markdown templates](https://jamstack.org/generators/) instead of Quarto. -[^reader]: Depending on your operating system and personal preference, you can choose any e-reader app you like, as long as it is capable of importing a file-based Calibre library. \ No newline at end of file +[^reader]: Depending on your operating system and personal preference, you can choose any e-reader app you like, as long as it is capable of importing a file-based Calibre library.