install.org 3.7 KB

Installation

The reference implementation of Org is part of Emacs. If you already have Emacs installed, you can start using org-mode right away!

Get Emacs

You can install the latest version of Org as a package by invoking ~M-x package-install RET org RET~ once you have configured Emacs to include Org ELPA as a package repository.

Alternatively you can download the package as a tar.gz or zip archive.

The bleeding-edge development version or Org is available at code.orgmode.org. You can clone the repo via:


~$ git clone https://code.orgmode.org/bzg/org-mode.git

Daily snapshots of the development version are released as tar.gz or zip files.

Worg has documentation about build options and about how to stay on the bleeding edge.

There are also many packages that augment Org available on MELPA.

Get started

Once you're ready to Org, check out the Quickstart page for an overview of the syntax.

Doom, Spacemacs, Scimax and popular configs

:PROPERTIES: :CUSTOM_ID: configs :END:

The Emacs starter kits Doom, Spacemacs and Scimax come with a curated set of packages and configurations that aim to enhance Org mode (and Emacs more generally) for particular use cases. They include Org along with integrations between org-mode and other modes (such as =evil-mode=). Here are links to the current packages included with Doom, and Spacemacs. Scimax is deeply integrated with Org so a good place to start is the manual. Doom installs a version of Org that is close to the development HEAD, while Spacemacs and Scimax track org elpa.

Starter kits often make significant changes to the default user experience for Emacs. If you are looking for something closer to vanilla Emacs there are popular configs such as Purcell's emacs.d that include org-mode customization and Org-related packages.

In Other Editors

    While the full set of Org [[file:features.html][features]] is currently exclusive to Emacs, basic functionality for Org files has been implemented for a variety of editors. Here are some extensions for other editors that enable support for Org files.
  • Vim :: vim-orgmode and org.vim
  • Atom :: org-mode
  • VSCode :: vscode-org-mode
  • Sublime :: Orgmode for ST 2 & 3