{"id":13469150,"url":"https://github.com/vscode-org-mode/vscode-org-mode","last_synced_at":"2025-05-15T16:08:31.103Z","repository":{"id":19428895,"uuid":"87017711","full_name":"vscode-org-mode/vscode-org-mode","owner":"vscode-org-mode","description":"Emacs Org Mode for Visual Studio Code","archived":false,"fork":false,"pushed_at":"2024-04-13T00:52:20.000Z","size":58004,"stargazers_count":1674,"open_issues_count":73,"forks_count":83,"subscribers_count":42,"default_branch":"develop","last_synced_at":"2024-10-29T17:27:27.633Z","etag":null,"topics":["emacs","org-mode","orgmode","plain-text","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://vscode-org-mode.github.io/vscode-org-mode/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vscode-org-mode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-02T21:35:11.000Z","updated_at":"2024-10-27T22:16:51.000Z","dependencies_parsed_at":"2024-06-14T22:55:55.933Z","dependency_job_id":"af0319fc-7659-49af-8126-17d4885cab0d","html_url":"https://github.com/vscode-org-mode/vscode-org-mode","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-org-mode%2Fvscode-org-mode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-org-mode%2Fvscode-org-mode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-org-mode%2Fvscode-org-mode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vscode-org-mode%2Fvscode-org-mode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vscode-org-mode","download_url":"https://codeload.github.com/vscode-org-mode/vscode-org-mode/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247730069,"owners_count":20986404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emacs","org-mode","orgmode","plain-text","vscode","vscode-extension"],"created_at":"2024-07-31T15:01:27.935Z","updated_at":"2025-04-07T21:14:48.995Z","avatar_url":"https://github.com/vscode-org-mode.png","language":"TypeScript","readme":"# VS Code Org Mode\n[![Version](https://vsmarketplacebadge.apphb.com/version/vscode-org-mode.org-mode.svg)](https://marketplace.visualstudio.com/items?itemName=vscode-org-mode.org-mode)\n[![Installs](https://vsmarketplacebadge.apphb.com/installs/vscode-org-mode.org-mode.svg)](https://marketplace.visualstudio.com/items?itemName=vscode-org-mode.org-mode)\n[![Ratings](https://vsmarketplacebadge.apphb.com/rating/vscode-org-mode.org-mode.svg)](https://marketplace.visualstudio.com/items?itemName=vscode-org-mode.org-mode)\n[![Travis](https://img.shields.io/travis/com/vscode-org-mode/vscode-org-mode.svg)](https://travis-ci.com/vscode-org-mode/vscode-org-mode)\n[![codecov](https://codecov.io/gh/vscode-org-mode/vscode-org-mode/branch/master/graph/badge.svg)](https://codecov.io/gh/vscode-org-mode/vscode-org-mode)\n[![License](https://img.shields.io/github/license/vscode-org-mode/vscode-org-mode.svg)](./LICENSE.txt)\n\n:warning: The publisher name was changed, **tootone/org-mode has become vscode-org-mode/org-mode** :warning:\n\nVS 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.\n\nWe welcome issues, feature requests, and contributions to the [repo](https://github.com/vscode-org-mode/vscode-org-mode).\n\n## Features\n\n### Keep Notes\n\nCreate outlines:\n\n![outlines](images/screenshots/01_outlines.gif)\n\nPromote and demote items:\n\n![promote_demote](images/screenshots/02_promote_demote.gif)\n\n### Maintain TODO Lists\n\nCreate TODOs:\n\n![create todos](images/screenshots/03_create_todos.gif)\n\nChange TODO status:\n\n![cycle todo status](images/screenshots/04_cycle_todo_status.gif)\n\nCustomize your TODO Keywords:\n\n![custom todos](images/screenshots/05_customize_todo_keywords.gif)\n\nInsert timestamps:\n\n![timestamps](images/screenshots/06_insert_timestamps.gif)\n\nModify dates:\n\n![modify dates](images/screenshots/07_modify_dates.gif)\n\n### Author Documents\n\nStyle your text:\n\n![style text](images/screenshots/08_style_text.gif)\n\nAdd metadata with a snippet:\n\n![add metadata](images/screenshots/09_add_metadata.gif)\n\nAdd links with a snippet:\n\n![add links](images/screenshots/10_add_links.gif)\n\nAdd comments:\n\n![add comments](images/screenshots/11_add_comments.gif)\n\n## Settings\n\n### Keybindings\n\nAll actions in VS Code Org mode come packaged with default keybindings. These can be modified in your `keybindings.json` file.\n\n### Custom TODO Keywords\n\nTODO keywords can be customized in `settings.json`. For example:\n```json\n\"org.todoKeywords\": [\n    \"TODO\",\n    \"DONE\",\n    \"WAIT\",\n    \"SCHD\"\n]\n```\n\n## Installation\n\nOrg Mode can be installed in a number of ways:\n  - Launch VS Code Quick Open (Linux / Windows: \u003ckbd\u003ectrl\u003c/kbd\u003e+\u003ckbd\u003eP\u003c/kbd\u003e; Mac: \u003ckbd\u003ecmd\u003c/kbd\u003e+\u003ckbd\u003eP\u003c/kbd\u003e) and type `ext install org-mode`.\n  - Search for `org mode` in the `Extensions` view in VS Code.\n\n![install](images/screenshots/14_install.gif)\n\n## Activation\n\nThe extension can be activated in two ways:\n1. Save a file with the extension `.org`.\n2. Change the language mode to `Org` by either\n    - Clicking in the lower right corner to the left of the smiley face\n    - Typing `change language mode` into the command palette\n    - Using the default shortcut\n        - Linux / Windows: \u003ckbd\u003ectrl\u003c/kbd\u003e+\u003ckbd\u003ek\u003c/kbd\u003e \u003ckbd\u003em\u003c/kbd\u003e\n        - Mac: \u003ckbd\u003ecmd\u003c/kbd\u003e+\u003ckbd\u003ek\u003c/kbd\u003e \u003ckbd\u003em\u003c/kbd\u003e\n\n## Docs\n\nDetailed documentation is kept in the [GitHub Wiki](https://github.com/vscode-org-mode/vscode-org-mode/wiki).\n\n## Contributing\n\nWe welcome contributions to the GitHub repo. Here are basic guidelines for conventions.\n\nJoin the community [here](https://gitter.im/vscode-org-mode/Lobby).\n\n### Naming\n\nThe 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`.\n\nCommands 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`.\n\nFilenames use kebab case, eg `header-functions.ts`.\n\nWhen 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/).\n\n### Code\n\nUse TSLint with default settings.\n\n### Git\n\n- `master` is used for production deploys.\n- `develop` is the main branch into which new features are merged. It is protected from direct pushes, so all changes come from pull requests.\n- 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/`.\n\n## Gratitude\n\nThe 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).\n\nOur 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.\n\n## License\n\nThis work is available under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html).\n\n## Requirements\n\nInstall the extension. The rest will be taken care of.\n\n## Known Issues\n\n### Colorization\n\nColorization, 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.\n\n### Others\n\nSee [GitHub Issues](https://github.com/vscode-org-mode/vscode-org-mode/issues).\n\n## Release Notes\n\nSee [CHANGELOG.md](https://github.com/vscode-org-mode/vscode-org-mode/blob/develop/CHANGELOG.md).\n","funding_links":[],"categories":["TypeScript","vscode-extension"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvscode-org-mode%2Fvscode-org-mode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvscode-org-mode%2Fvscode-org-mode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvscode-org-mode%2Fvscode-org-mode/lists"}