Skip to content

Repository files navigation

Sheerluck's Digital Garden

An Obsidian-compatible digital garden built with Quartz 5 and prepared for Cloudflare Pages at notes.sheerluck.dev.

Write in Obsidian

Open the content directory as the vault. Its stable structure is:

content/
├── notes/       notes, kept flat (one idea per note)
├── sources/     source records, kept flat
├── articles/    long-form writing, grouped by topic or series
│   ├── rust/    Rust lessons
│   └── gpui/    GPUI lessons
├── templates/   Obsidian templates for new notes, articles, and sources
└── __support/   images, PDFs, audio, and video

New attachments are directed to __support by the committed Obsidian settings. Pages are published only when their frontmatter contains publish: true.

The templates folder is ignored by Quartz and contains note.md, article.md, and source.md starter files. In Obsidian, enable the Templates core plugin and set its template folder to templates.

For an article series, optionally add previous and/or next to the article frontmatter. Each value can be an Obsidian wikilink (for example, next: "[[Part 2 — Borrowing]]") or a page slug. The navigation appears below the article only when a matching link is provided.

Articles within a series use a numeric order property, starting at 1. Folder listings and the website's Explorer sidebar show lower numbers first, followed by articles without a number. Ordering applies within each article folder. Other sections retain their existing sorting.

order: 1
published: 2026-10-01

published is optional and should contain the actual publication date in YYYY-MM-DD format. Quartz supports sorting and displaying this date by setting the created-modified-date plugin's defaultDateType to published; the current site uses modified as its default date, with order taking precedence for article series. Publication dates are not inferred from file moves or edits.

Each series can have a published index.md for its title and introduction. When moving an already published article, add its former path under aliases to preserve its old URL through a redirect. Filename-only wikilinks continue to resolve when filenames are unique; update any links that explicitly include the old folder path.

Use this source convention in notes:

> [!source] Source
> [[Source note title]] [in](https://example.com/exact-section)

Local preview

Requires Node 22 or newer.

npm ci
npx quartz build --serve

The preview is served at http://localhost:8080.

Cloudflare Pages

Connect the repository to Cloudflare Pages with:

  • Framework preset: None
  • Build command: npx quartz plugin install && npx quartz build
  • Build output directory: public
  • Production branch: your repository's default branch
  • Custom domain: notes.sheerluck.dev

The checked-in .node-version pins a Quartz-compatible Node release.

GitHub Sponsors is linked to MrSheerluck and configured in .github/FUNDING.yml. The homepage links directly to the verified subscription page at mrsheerluck.substack.com, with social links on the About page and in the footer.

Quartz

About

This is my digital garden where you'll find all my notes, articles and sources. It replicates my obsidian setup

Resources

Code of conduct

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages