Skip to content

Add headings and links from org files in one or more directories to a sqlite database

License

Notifications You must be signed in to change notification settings

hubisan/org-files-db

Repository files navigation

Org-files-db

https://img.shields.io/badge/License-GPL%20v3-blue.svg

Adds headings and links from org files in one or more directories to a sqlite database.

Main features

  • Adds headings and links from org files in one or more directories to a sqlite database.
  • For each heading it stores the filename, line number, title, level, priority, todo keyword, statistic cookies, planning info (scheduled, deadline, closed), parent heading id, tags and properties.
  • For each link it stores the filename, position, full link, type, link and description.
  • Provides queries for the most common use cases.
  • Uses ugrep to quickly parse the files and reparses files if modified.

Contents

Installation

The packages is available on github. My preferred way to install is with leaf and straight:

(leaf org-files-db
  :straight (org-files-db :type git :host github :repo "hubisan/org-files-db"))

Usage

<Usage description>

Customization

Variables

Set the following variables to change the behaviour of the package:

VariableDefaultDescription

Faces

The following faces are defined:

FaceDescription

Key Bindings

<whatever needs to be said about that>

KeyActionDescription

Hydra

<if there is any hydra>

Changelog

See the changelog.

Contributing

Use the issue tracker to reports bugs, suggest improvements or propose new features. If you want to contribute please open a pull request after having opened a new issue.

In any case please check out the contributing guidelines beforehand.

About

Add headings and links from org files in one or more directories to a sqlite database

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published