VS Code Org Mode
VS Code Org Mode is an extension for Visual Studio Code inspired by the venerable Org mode for Emacs. Org lets you keep notes, maintain TODO lists, and author documents, all in plain text.
The extension is currently in alpha. We welcome issues, feature requests, and contributions to the repo.
Promote and demote items:
Maintain TODO Lists
Change TODO status:
Customize your TODO Keywords:
Style your text:
Add metadata with a snippet:
Add links with a snippet:
All actions in VS Code Org mode come packaged with default keybindings. These can be modified in your
Custom TODO Keywords
TODO keywords can be customized in
Org Mode can be installed in a number of ways:
The extension can be activated in two ways:
Detailed documentation is kept in the GitHub Wiki.
We welcome contributions to the GitHub repo. Here are basic guidelines for conventions.
The full name of this project is
Commands are prefixed with
Filenames use kebab case, eg
When referring to the original Org mode, we capitalize the "O" and leave the "m" lower case. This is in keeping with the original team's usage on orgmode.org.
Use TSLint with default settings.
The original Org mode was written for Emacs by Carsten Dominik, with the help and support of an impressive list of geniuses. Our work is inspired by though not associated with their original masterpiece. In addition, many aspects of the extension were inspired by the Spacemacs Org layer.
This work is available under the GNU General Public License v3.
Install the extension. The rest will be taken care of.
VS Code's folding strategy is based on indentation. There is no indentation in Org. There are a number of feature requests to allow for header-level folding:
Until Microsoft addresses those issues, it appears to be impossible to implement folding in Org.
Colorization, bolding, italicization, and other modes of highlighting are handled differently by different themes. We have prioritized supporting the default VS Code themes (Dark+ and Light+). This prioritization means that some colors may not appear as expected in other themes, or that opportunities for more variance have been missed.
See GitHub Issues.