Org-mode for developers
Org-mode for developers
This page gather links to reference documentation and (forthcoming) tutorials on how to extend Org.
Git workflow
Org development uses a two-branches git workflow.
- main
- This branch contains the latest development for Org.
Temporary feature branches (either local or remote) should
branch out from
main
. New features should be introduced into org onmain
. This branch is merged to thebugfix
branch when a major release is made. - bugfix
- This branch is the "production" branch for Org. It
contains stable releases and bug fixes against them. Bugs
present in a release should always be fixed on
bugfix
, which is then merged back intomain
so that the two branches keep the same bugfixes. Minor releases are made so that not too many bug fixes are pending onbugfix
. The Org version on this branch is regularly sync'ed with the Emacs repository.
Git repositories
The git repository for Org is on orgmode.org
:
If you are a developer, you can clone it like this:
~$ git clone git://git.savannah.gnu.org/emacs/org-mode.git
To clone a read-only version of the repo:
~$ git clone https://git.savannah.gnu.org/git/emacs/org-mode.git
Reference documentation
- Syntax reference (draft)
- Org Element API for the Org parser (
org-element.el
). - Reference documentation for the new export engine (
ox.el
) written by Nicolas Goaziou. - Org-mode's doc for all hooks, commands and options.
Tips
- Org Build System (aka Makefile)