Now I accumulated a set of useful knowledge nuggets that I’m returning to again and again. I think these notes can be useful not only for myself. So I decided to export them into my braindump - a static site with my notes.
In this post, I’ll describe simple steps to create a static site with your braindump.
I use org-roam to take my notes. Org-roam uses org mode files for notes. Org-roam is one of the most powerful note-taking tools.
Some static site generators have built-in support for org-mode files but you can easily export them to different formats (markdown, html, etc). The list of projects I’ve tried:
- firn - Org Mode Static Site Generator. It doesn’t support uppercase org properties used by org-roam.
- zola - A fast static site generator in Rust. Being a fan of the Rust language myself, the idea of using it seemed nice. But I couldn’t find a good enough theme for my notes :)
- hugo - A static site generator in Go. It’s the most popular one on this list. And there are already braindump sites using it. For example, https://braindump.jethro.dev/ and https://sidhartharya.me/braindump/index.html. So I decided to go with it.
The only problem I experienced is that the note export wasn’t smooth for me. So for now I exported just a handful of notes, but I’m planning to create some kind of tool to easily export my public notes with a single command.
Tweaking Hugo theme
I chose the cortex Hugo theme by Jethro Kuan. But in my opinion, it has a big flaw - it doesn’t have search functionality. I think this feature a critical to make your braindump useful not only for people visiting your site but also for yourself. So I decided to add this functionality.
Fortunately, I’m not the first person stumbling upon this problem. There is a good post describing steps to add search with lunr.js. So I used this post to add a search feature to my braindump. Also, I created a PR to Jethro Kuan’s cortex theme with my changes.
Another modification I made to the cortex theme is I changed its CSS styles to make my braindump darker. Because everything looks cooler in the dark mode. You can find my version of the cortex theme at https://github.com/ayrat555/cortex-dark. I’m by no means a CSS expert so my changes may seem dirty for some of you. But it got the job done.
Deploying on GitHub pages
The last step is to deploy a braindump. I used github pages for that. You can host your public static sites freely on github and the deployment process is super easy. You can find the source code of my braindump at https://github.com/ayrat555/braindump.
- https://github.com/ayrat555/cortex-dark - dark theme for braindump (hugo)
- https://github.com/ayrat555/braindump - source code for my braindump
- https://braindump.badykov.com/ - my braindump
The task for next weekend is to figure out a way to smoothly export my public notes. ;)