Giter VIP home page Giter VIP logo

org-backlinks's Introduction

org-backlinks

An interface for searching backlinks to Org headings.

This package aims to provide a sense of context when searching for links to and from the current note.

Backlinks are the Org headings that have links to the current Org heading at point. Second order backlinks are the backlinks to each of the current heading’s backlinks. Third order backlinks are the same but for the second order ones.

Optionally, it can also show the direct and indirect links of a note.

Direct links are the links to other headings present in the current heading. Indirect links are the direct links present in those headings.

diagram.png

The optional package helm-org-backlinks provides a Helm interface for org-backlinks.

This package requires org-ql.

Installation

Clone this repo and add it to your load-path:

(add-to-list 'load-path "/path/to/org-backlinks")
(require 'org-backlinks)
(require 'helm-org-backlinks) ; optional helm interface

Or, with use-package + straight.el:

(use-package org-backlinks
  :straight (org-backlinks :host github :repo "bcardoso/org-backlinks"
                           :files ("org-backlinks.el"))
  :bind ("C-c z" . org-backlinks))

;; optional helm interface
(use-package helm-org-backlinks
  :straight (helm-org-backlinks :host github :repo "bcardoso/org-backlinks"
                                :files ("helm-org-backlinks.el"))
  :bind ("C-c z" . helm-org-backlinks))

Usage

Just run M-x org-backlinks or with the suggested binding C-c z in a Org heading.

Or, if you are a Helm user, run M-x helm-org-backlinks.

org-backlinks will search the files defined by org-backlinks-files for the CUSTOM_ID or the ID of the current Org heading.

Set org-backlinks-show-direct-links to t to see both the direct and indirect links to other headings.

The other customizable variables are accessible through the customize interface:

  • M-x customize-group RET org-backlinks.

org-backlinks's People

Contributors

bcardoso avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

anthrolisp

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.