jnsgruk / cm-editor-syntax-highlight-obsidian

A plugin for [Obsidian](https://obsidian.md) which allows syntax highlighting for code blocks in the editor.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Editor Syntax Highlight Obsidian Plugin

A plugin for Obsidian which allows syntax highlighting for code blocks in the editor.

Screenshot

Imports code from CodeMirror

Compatibility

Custom plugins are only available for Obsidian v0.9.7+.

The current API of this repo targets Obsidian v0.9.7.

Notes

This is all very expermental at the moment, so parts might not work, etc.

This imports a bunch of syntax highlighting modes from CodeMirror, as well as the yonce theme for dark mode.

Installation

From within Obsidian

From Obsidian v0.9.8, you can activate this plugin within Obsidian by doing the following:

  • Open Settings > Third-party plugin
  • Make sure Safe mode is off
  • Click Browse community plugins
  • Search for "Syntax Highlight"
  • Click Install
  • Once installed, close the community plugins window and activate the newly installed plugin

Updates

You can follow the same procedure to update the plugin

From GitHub

  • Download the Latest release
  • Extract the cm-editor-syntax-highlight-obsidian folder from the zip to your vault's plugins folder: <vault>/.obsidian/plugins/
    Note: On some machines the .obsidian folder may be hidden. On MacOS you should be able to press Command+Shift+Dot to show the folder in Finder.
  • Reload Obsidian
  • If prompted about Safe Mode, you can disable safe mode and enable the plugin. Otherwise head to Settings, third-party plugins, make sure safe mode is off and enable the plugin from there.

Development

This project uses Typescript to provide type checking and documentation.
The repo depends on the latest plugin API in Typescript Definition format, which contains TSDoc comments describing what it does.

Note: The Obsidian API is still in early alpha and is subject to change at any time!

If you want to contribute to development and/or just customize it with your own tweaks, you can do the following:

  • Clone this repo.
  • npm i or yarn to install dependencies
  • npm run build to compile.
  • Copy manifest.json, main.js and styles.css to a subfolder of your plugins folder (e.g, <vault>/.obsidian/plugins/cm-editor-syntax-highlight-obsidian/)
  • Reload obsidian to see changes

Alternately, you can clone the repo directly into your plugins folder and once dependencies are installed use npm run dev to start compilation in watch mode.
You may have to reload obsidian (ctrl+R) to see changes.

Pricing

Huh? This is an open-source plugin I made for fun. It's completely free. However, if you absolutely have to send me money because you like it that much, feel free to throw some coins in my hat via PayPal or sponsor me via GitHub Sponsors

Version History

0.1.3

  • Fixed elixir mode (sorry this took me so long to release, it was fixed AAAGES ago...)
  • Added javascript syntax highlighting for dataviewjs blocks (thanks @dbarenholz)
  • Added YAML syntax highlighting for dataview and tracker blocks (thanks @KjellConnelly)

0.1.2

  • Added elixir mode (thanks to James Dalton)

0.1.1

  • Apply codemirror theme to latex math also

0.1.0

  • Adjusted the dark codemirror theme to also apply to frontmatter
  • Reload the editor modes on load, so syntax highlighting is shown on enable
  • Delete editor modes on unload, so syntax highlighting is hidden on disable

v0.0.1

Initial Release.
Copy-pasted and imported editor modes from CodeMirror 5.58.2. Got compiler errors importing markdown and gfm, so those aren't available for now.

ezoic increase your site revenue

About

A plugin for [Obsidian](https://obsidian.md) which allows syntax highlighting for code blocks in the editor.


Languages

Language:JavaScript 99.3%Language:TypeScript 0.4%Language:SCSS 0.3%Language:CSS 0.1%