Git Product home page Git Product logo

org-z's Introduction

org-z

Lightweight, Org-mode flavored zettelkasten links.

org-z is an Emacs global minor mode that enables a lightweight, Org mode style zettelkasten. Unlike a traditional zettelkasten, org-z focuses on headings rather than pages, allowing you to make hyperlinks within a single Org mode document.

By treating headings, rather than pages, as first-class, we can use standard functions that ship with org like org-store-link and packages like org-sidebar to maximum effect.

org-z has the following features:

  • Insert links to org headings with interactive search (C-c-. by default)
  • Links are managed automatically using org-store-link and org-ids
  • Links to new / missing targets auto-create targets in a configurable file location (new.org by default). Creation of the new heading is customizable using a capture template.

./images/existing-link.gif

./images/new-link.gif

Installation

Install with straight.el:

(use-package org-z
  :straight (org-z :type git :host github :repo "landakram/org-z")
  :config
  (org-z-mode 1))

A lightweight zettelkasten

I combine org-z with a daily journal, implemented as a file+datetree capture template, and org-sidebar backlinks.

(setq org-capture-templates
      '(;; ...
        ("j" "Journal entry" entry (file+datetree "~/org/journal.org")
         "* %?\n" :unnarrowed t)))

(use-package org-sidebar
  :ensure t
  :after (general)
  :config
  (leader-def :infix "o"
    "b" 'org-sidebar-backlinks))

As I go about my day, I make journal entries that link to various headings in my collection of org files. I make these links by invoking org-z-insert-link as I write my journal entry. I periodically open the backlinks sidebar to investigate connections.

Every once in a while, I review my journal entries and org-refile headings or simply re-organize journal entry knowledge into “longer-term storage” (reference.org or projects.org).

Motivation

I was inspired by org-roam, but wanted something that fit my existing org workflow, which is a handful of files with deep headings rather than a file per topic.

org-z's People

Contributors

landakram avatar

Watchers

James Cloos 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.