Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

Open in VSCode

This plugin for Obsidian makes a ribbon button and a command to open your vault as a Visual Studio Code workspace.

It's functionality is probably made redundant now using the Shell commands and Customizable Sidebar (or Buttons) plugins, but it'll be maintained for the foreseeable future.

You can use VSCode for various purposes with your vault, such as for git version control, markdown formatting with Prettier, linting with markdownlint, mass formatting files and more.

video showcase

The icons work with light and dark mode.

light and dark

You can also use it as a command and assign hotkeys to it. You can disable the ribbon button in settings. command

By default the plugin uses child_process to launch VSCode with the code command, but the previous method using URLs can still be enabled.

You can template the command opening VSCode however you like with its provided command line arguments. This way you can technically launch any command you set, so take caution. Potential use cases include opening workspaces with .code-workspace files (e.g. for Dendron), opening specific files, folders, etc.

Compatibility

The plugin was tested in Obsidian v0.11.13 and subsequent versions, but probably works with older versions.

Installation

You can install the plugin via the Community Plugins tab within Obsidian. You can also manually copy from releases to your .obsidian/plugins/open-vscode folder.

Issues

Using the URL method for opening, VSCode can't open a workspace without a further confirmation dialog (that you just can hit enter on) for security reasons. See this issue for more infomation.

Credits

Toggle ribbon setting by @ozntel.

Thank you to the makers of the DEVONlink plugin, as it was a great starting point for working with ribbon icons in Obsidian. The icon is from icon-icons.com and was resized with iLoveIMG.

Support

If you like this plugin you can support me on PayPal here: Paypal