Code Monkey home page Code Monkey logo

quartz-plus's Introduction

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

quartz-plus's People

Contributors

jackyzha0 avatar chaosarium avatar aidenybai avatar dhammacharts avatar meleu avatar claudio4 avatar bur3ku avatar geoffreygarrett avatar juaoose avatar apoorvkh avatar safeight avatar exu3 avatar plundration avatar pranavm7 avatar isaluki avatar sspaeti avatar siyangsun avatar slrvb avatar vincenthuang75025 avatar yshalsager avatar benbohmer avatar earnestma avatar abhmul avatar rphla avatar saucecoat avatar straightupjac avatar y1450 avatar nikolageorgiev2000 avatar morgangallant avatar husjon avatar

Stargazers

Simen Chen avatar now_its_dark avatar Roland Siegbert avatar Houjun Liu avatar chris avatar Xiang Fu avatar

Watchers

chris avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.