Nogweii's Notes site

This is my Bridgetown powered notes/documentation site. It's my own digital garden. I use Obsidian to actually write my notes, these are just a subset of them that I want to publish and share.

Prerequisites

• GCC
• Ruby (>= 4.0)
• Node (>= 25)

Interesting parts of the tech

• Core Framework: Bridgetown
• Server/Backend: Roda (via config.ru and server/roda_app.rb) running on Puma.
• Frontend:
  • CSS Framework: Bootstrap 5
  • Bundler: esbuild
  • Icons: Lucide

Neat extra features I've added

• Backlinks are built through scanning the notes and exposes them through custom metadata as well as a complete graph (in JSON)
• A file tree that supports icons and emojis while opening up to the correct node for the page
• Custom Markdown processing via CommonMarker & HTML::Pipeline
• An RSS feed, using the git modification times to order the notes

Install

cd notes-site
bundle install && npm install

Development

To the site in development mode, run bin/bridgetown start and navigate to localhost:4000. There is live-reload so it should automatically refresh the browser on changes.

Front-end files are built using esbuild in ./esbuild.config.js. The primary javascript file is located at ./frontend/javascript/index.js and the primary CSS file is located at ./frontend/styles/index.css.

Important Commands

# running locally
bin/bridgetown start

# build the site in dev mode
bin/bridgetown build

# build & deploy to production (rsync's to "website-server")
bin/bridgetown deploy

# load the site up within a Ruby console (IRB)
bin/bridgetown console

# Copy the latest version of notes from ~/notes/ (assumes it exists)
bundle exec rake sync:notes

# Copy the latest version of my resume from ../my-resume/ (assumes it exists)
bundle exec rake sync:resume