sponsor Vim development Vim logo Vim Book Ad

organ : Generalize Orgmode to Markdown and any Folded file

 script karma  Rating 8/2, Downloaded by 100  Comments, bugs, improvements  Vim wiki

created by
chimay orduval
 
script type
utility
 
description
# What is it ?

Organ generalizes the great concepts of Orgmode to Markdown and any folded file. It is primarily focused on editing these documents with ease and agility.

# More information

See the github repository :

[organ](https://github.com/chimay/organ)

# Compatibilty

Organ supports :

org files
markdown
asciidoc : headings only
folded files with markers
indent folded files : basic navigation only
It is written in vimscript and is compatible with both Vim and Neovim.

# Features

- folding based on headings in org and markdown files
- headings base on folding in folded files
  + you can handle your folds like in orgmode
- navigate in headings or list items hierarchy
  + next, previous : any level
  + forward, backward : same level as current one
  + parent heading, upper level
  + child heading, lower level :
    - loosely speaking : first headline of level + 1, forward
    - strictly speaking : must be in the current subtree
  + go to another headline with prompt completion of full path
- modify headings or list items
  + new headline or list item
  + select, yank, delete subtree
  + promote, demote heading or list item
  + move subtree up or down
  + move current subtree in another one (aka org-refile)
- expand shortcut to template (aka org-structure-template)
  + markdown support limited to code blocks
- links
  + store url at cursor
  + create link with url completion
  + goto link under or close to cursor
  + goto next/previous link
- tables
  + inside of table : align columns
  + outside of table : align following a pattern
  + add new row, colum
  + delete row, colum
  + move row up or down
  + move column left or right
- cycle todo status
- insert timestamp
- export in another format using
  + pandoc
  + emacs
  + asciidoc or asciidoctor
  + view exported document
- convert headings and links org <-> markdown

# Differences with standard orgmode

- speed keys are also available in first char of list item line
- movements can
  + wrap around the end of the file
  + cross over a parent headline

# Dependencies

The core part runs on its own.

Some extra-features need external tools, see below.

## Export

If you want to export your file to another format, you just need to have
pandoc installed, and the plugin takes care of the rest.  For org files,
it can also be done with emacs installed, at least for the formats
supported by orgmode.

For asciidoc files, you need to install asciidoc or asciidoctor.

## Across files

If you want to add interactions between org or markdown files, you can
install [wheel](https://github.com/chimay/wheel). With it, you can :

- quickly jump to another org/markdown/whatever file
- look for headlines in all orgmode or markdown files of a group (aka outline)
- grep all your group files for special keywords, like TODO
 
install details
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
organ-1.0.tar.gz 1.0 2023-05-11 8.0 chimay orduval Initial upload
ip used for rating: 3.128.199.210

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
Vim at Github