What is it built on?

This site is built on Quartz, a very cool static-site generator that converts Markdown files into webpages (like this one).

The Pieces

This website has two GitHub repositories behind the scenes - one for content, and one for Quartz itself. These repositories work together via GitHub actions to convert the Markdown notes into static pages, which are then hosted by GitHub.

sequenceDiagram
    participant Contributor
    participant ContentRepo
    participant QuartzRepo

	Contributor->>Contributor: Locally edits content
    Contributor->>ContentRepo: Periodic pushes to GitHub
    Contributor->>ContentRepo: Opens PR to merge into main
    ContentRepo-->>QuartzRepo: Sends event via GitHub Actions
    QuartzRepo->>QuartzRepo: Receives  event
    QuartzRepo->>ContentRepo: Pulls latest main branch
    QuartzRepo->>QuartzRepo: Builds site using Quartz
    QuartzRepo->>GitHub Pages: Deploys site


How do you add to it?

Check out the Contributor’s guide which describes exactly how to add or edit notes to the website.