Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vscode-org-mode/vscode-org-mode
Emacs Org Mode for Visual Studio Code
https://github.com/vscode-org-mode/vscode-org-mode
emacs org-mode orgmode plain-text vscode vscode-extension
Last synced: about 1 month ago
JSON representation
Emacs Org Mode for Visual Studio Code
- Host: GitHub
- URL: https://github.com/vscode-org-mode/vscode-org-mode
- Owner: vscode-org-mode
- License: gpl-3.0
- Created: 2017-04-02T21:35:11.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-13T00:52:20.000Z (7 months ago)
- Last Synced: 2024-04-14T19:56:35.522Z (7 months ago)
- Topics: emacs, org-mode, orgmode, plain-text, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://vscode-org-mode.github.io/vscode-org-mode/
- Size: 55.3 MB
- Stars: 1,633
- Watchers: 40
- Forks: 82
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# VS Code Org Mode
[](https://marketplace.visualstudio.com/items?itemName=vscode-org-mode.org-mode)
[](https://marketplace.visualstudio.com/items?itemName=vscode-org-mode.org-mode)
[](https://marketplace.visualstudio.com/items?itemName=vscode-org-mode.org-mode)
[](https://travis-ci.com/vscode-org-mode/vscode-org-mode)
[](https://codecov.io/gh/vscode-org-mode/vscode-org-mode)
[](./LICENSE.txt)
:warning: The publisher name was changed, **tootone/org-mode has become vscode-org-mode/org-mode** :warning:
VS Code Org Mode is an extension for Visual Studio Code inspired by the venerable [Org mode for Emacs](http://orgmode.org/). Org lets you keep notes, maintain TODO lists, and author documents, all in plain text.
We welcome issues, feature requests, and contributions to the [repo](https://github.com/vscode-org-mode/vscode-org-mode).
## Features
### Keep Notes
Create outlines:
Promote and demote items:
### Maintain TODO Lists
Create TODOs:
Change TODO status:
Customize your TODO Keywords:
Insert timestamps:
Modify dates:
### Author Documents
Style your text:
Add metadata with a snippet:
Add links with a snippet:
Add comments:
## Settings
### Keybindings
All actions in VS Code Org mode come packaged with default keybindings. These can be modified in your `keybindings.json` file.
### Custom TODO Keywords
TODO keywords can be customized in `settings.json`. For example:
```json
"org.todoKeywords": [
"TODO",
"DONE",
"WAIT",
"SCHD"
]
```
## Installation
Org Mode can be installed in a number of ways:
- Launch VS Code Quick Open (Linux / Windows: ctrl+P; Mac: cmd+P) and type `ext install org-mode`.
- Search for `org mode` in the `Extensions` view in VS Code.
## Activation
The extension can be activated in two ways:
1. Save a file with the extension `.org`.
2. Change the language mode to `Org` by either
- Clicking in the lower right corner to the left of the smiley face
- Typing `change language mode` into the command palette
- Using the default shortcut
- Linux / Windows: ctrl+k m
- Mac: cmd+k m
## Docs
Detailed documentation is kept in the [GitHub Wiki](https://github.com/vscode-org-mode/vscode-org-mode/wiki).
## Contributing
We welcome contributions to the GitHub repo. Here are basic guidelines for conventions.
Join the community [here](https://gitter.im/vscode-org-mode/Lobby).
### Naming
The full name of this project is `VS Code Org Mode`. It is abbreviated `vscode-org-mode`. In the VS Code Marketplace, it is listed as `Org Mode`.
Commands are prefixed with `org.` and followed by camel case, eg `org.insertHeadingRespectContent`. Command titles are prefixed with `Org: ` and followed by capitalized words separated by spaces, eg `Org: Insert Heading Respect Content`.
Filenames use kebab case, eg `header-functions.ts`.
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](http://orgmode.org/).
### Code
Use TSLint with default settings.
### Git
- `master` is used for production deploys.
- `develop` is the main branch into which new features are merged. It is protected from direct pushes, so all changes come from pull requests.
- Features: For all new additions, create a new feature branch. When complete, create a pull request into `develop` for that branch. Optionally, prefix feature branch names with `feature/`.
## Gratitude
The original Org mode was written for Emacs by Carsten Dominik, with the help and support of [an impressive list of geniuses](http://orgmode.org/org.html#History-and-Acknowledgments). 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](https://github.com/syl20bnr/spacemacs/tree/master/layers/%2Bemacs/org).
Our unicorn icon is based on an image by [M. Turan Ercan](https://thenounproject.com/mte/) for [the Noun Project](https://thenounproject.com/). We're grateful to them for making the image available under the Creative Commons license.
## License
This work is available under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html).
## Requirements
Install the extension. The rest will be taken care of.
## Known Issues
### Colorization
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.
### Others
See [GitHub Issues](https://github.com/vscode-org-mode/vscode-org-mode/issues).
## Release Notes
See [CHANGELOG.md](https://github.com/vscode-org-mode/vscode-org-mode/blob/develop/CHANGELOG.md).