8000 GitHub - emacsmirror/org-tidy: A minor mode to tidy org-mode buffers
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

emacsmirror/org-tidy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

org-tidy

🧹 An Emacs minor mode to automatically tidy org-mode property drawers.

Why?

Org-mode’s property drawer is a very useful feature. We can store properties associated with an entry in property drawer. I use org-roam every day. And org-roam node is an entry with ID property. But if I create many nodes in a single file, there will be a lot of property drawers. This is really annoying. Even after they are folded, there are still lines like :PROPERTIES: ... , which makes the whole buffer hard to read.

At first I googled for some tricks to hide property drawers completely. And I found there are many people like me who are bothered by this problem. Of course there are solutions. But these solutions involve a lot of code. So I made this package.

Screenshots

After org-tidy mode is turned on, these property drawers are hidden. And the symbol ♯ is appended after the headline. You can also customize how property drawers will be hidden.

Usage

Manual

(require 'org-tidy)
(add-hook 'org-mode-hook #'org-tidy-mode)

use-package

(use-package org-tidy
  :ensure t
  :config
  (add-hook 'org-mode-hook #'org-tidy-mode))

Customize

org-tidy-top-property-style

How to display the property at the beginning of buffer. keep will do nothing. invisible will hide it.

org-tidy-properties-style

How to display other property drawers.

  • fringe will hide the property drawer and show a indicator in the left fringe
  • inline will hide the property drawer and append a symbol (default to ♯) at the end of previous line
  • invisible will just hide the property drawer

org-tidy-properties-inline-symbol

The inline symbol.

About

A minor mode to tidy org-mode buffers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

No packages published

Languages

  • Emacs Lisp 100.0%
0