/obsidian-vscode-editor

Edit Code Files like VSCode in Obsidian.

Primary LanguageTypeScriptMIT LicenseMIT

Obsidian VSCode Editor

Release version Download count

A third-party plug-in of Obsidian that provides viewing and editing functions for files in various code formats
简体中文 · English

About the plugins

Obsidian by default does not support the viewing and editing of various code files, and Obsidian VSCode Editor was created to solve this problem.

It is based on Monaco Editor (VSCode Editor kernel) development, support for viewing and editing of various code format files, including but not limited to: C, C++, C# , CSS, Go, HTML, Java, JavaScript, JSON, Python, Ruby, Rust, Shell, XML, YAML, ini, etc.

You no longer have to open another editor just to view or edit a certain code file, everything is done in Obsidian.

Basic features

  • Support for viewing and editing files in various code formats, just like editing code with VSCode.
  • Supports customization of the editor's theme colors, including light and dark themes.
  • Allows customization of the editor's font size, and provides a shortcut to adjust the font size using Ctrl + mouse wheel.
  • Provides the option to show/hide line numbers.
  • Offers the choice to display/hide indent guides.
  • Allows toggling the display of the code minimap.
  • Supports shortcut icon buttons or commands for creating new code files.

Use screenshot

  • Light color theme image.png

  • Dark color theme image.png

  • Create code file image.png

  • Editor setting panel image.png

Installation

Installation from Obsidian's community plugins:

  1. Open Settings > community plugins
  2. Turn off 'Safe mode'
  3. Click 'Browse' button to browse plugins
  4. Search for 'VSCode Editor'
  5. Click 'Install' button
  6. Once installed, close the plugins browse window and go back community plugins window, and activate the newly installed plugin below installed plugins list

Manual installation:

  1. Enter the latest version of making download page latest release
  2. Download the obsidian-vscode-editor-x.y.z.zip file, where x.y.z is the version number
  3. Extract obsidian-image-toolkit folder from the zip to your vault's plugins folder <vault>/.obsidian/plugins/ (Note: .obsidian folder may be hidden, you need to show it firstly)
  4. Open Settings > community plugins, and reload and activate the plugin below installed plugins list

Contact

If you've got any kind of feedback or questions, feel free to reach out via GitHub issues.