Skip to content

hugo static site generator for website 3.0; a superset of quartz optimised for an Obsidian vault with preprocessing and postprocessing scripts

License

Notifications You must be signed in to change notification settings

chaosarium/quartz-plus

Repository files navigation

A Superset of Quartz

Based on quartz by @jackyzha0.

Existing features:

  1. Extremely fast natural-language search
  2. Customizable and hackable design based on Hugo
  3. Automatically generated backlinks, link previews, and local graph
  4. Built-in CJK + Latex Support and Admonition-style callouts
  5. Support for both Markdown Links and Wikilinks

Added features:

  1. Preprocessing script for better Obsidian vault integration and publishing control (use "publish: true" in yaml frontmatter to whitelist files)
  2. Copying attachments from Obsidian to the right place (thereby supporting wikilink without leading folder path)
  3. Uses first h1 in markdown as title in frontmatter so that Hugo is happy (othewise use filename as title)
  4. Support wikilink media embed like Obsidian does, including video, pdf, and audio embed
  5. Fancy table of content on the side (with chunker script that puts each heading in its isolated div)
  6. Pretty calendar embed using FullCalendar
  7. Custom theme
  8. Layout system - supports specifying layout in yaml metadata
  9. Postprocessing script to clean up graph so that non-existent links or nodes don't show up
  10. GitHub workflow to build website from vault repo and deploy to branch on same or different repo (supports private repo)
  11. Netlify deployment support (by supporting case-insensitive url)
  12. Walk through markdown files and add inline tags to yaml metadata

Roadmap:

  • Excalidraw support
  • Mermaid support (implemented by this PR)
  • Fix broken links
  • Title generation
  • Publishing control
  • Fix media embed
  • Fix orphan not showing up (partially fixed)
  • Fix Callout behaviour consistency with Obsidian (jackyzha0/quartz#268)
  • Don't draw/Draw muted node if file does not exist
  • Custom home page
  • Nav bar
  • Table of content on sidebar
  • Obsidian inline tag support
  • Pretty calendar embed support
  • Footnotes as sidenotes (inspiration -> https://github.com/capnfabs/paperesque)

“[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming

About

hugo static site generator for website 3.0; a superset of quartz optimised for an Obsidian vault with preprocessing and postprocessing scripts

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published