org-mode + org-roam + Hugo + Hugo themes + github/gitlab

Table of Contents

org-mode + org-roam + Hugo + Hugo themes + github/gitlab

  1. Export the org files into md files using ox-hugo
  2. Use a hugo template to package them
  3. Link the GitHub private repo to a hosting platform like Vercel
  4. Publish them using the hosting platform

Cons of this approach

  1. We have to use custom hugo themes.
    1. The functionality that is going on in those theme is a mystery.
    2. That can be a rabbit hole.
    3. We are always searching for the next best hugo theme. There are so many of them out there but not a single one that meets all of your criteria. It is a time-sink.
  2. We need to build pagefind index because the search feature is NOT built into these custom themes.
    1. The pagefind index can be huge.
    2. Saving all of those indexes to gitlab or github is a waste of space and bandwidth.

Pros of this approach

  1. The table of contents feature works great
  2. If we find a theme that we like, and if we can stick to it, things will be simple and straight-forward.

Links to this note