https://github.com/mrgvsv/obsidian-better-comment-toggle

https://github.com/mrgvsv/obsidian-better-comment-toggle

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mrgvsv/obsidian-better-comment-toggle
• Owner: MrGVSV
• License: mit
• Created: 2023-07-14T07:28:08.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-24T20:14:33.000Z (about 1 year ago)
• Last Synced: 2024-10-03T19:10:49.268Z (3 months ago)
• Language: TypeScript
• Size: 1.59 MB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Better Comment Toggle

*Improved comment toggling in Obsidian.*

## Features

- Easily toggle comments line-by-line or over a selected range of lines

- Configure the start and end tokens for toggled comments

- Change the appearance of commented lines

- Support for both code and math blocks (including custom languages)

- Maintains indentation

## Demos



  



## Details

This plugin is purely WYSWIG. That is, there are no hidden HTML tags or other metadata embedded into your notes. The comments exist as you see them in the notes. Any additional styling (e.g. font color) is purely cosmetic and exists only in the editor.

The default comment style is set to HTML (``), which is the syntax specified by [CommonMark](https://spec.commonmark.org/0.30/#example-624). However, you can configure this plugin to use Obsidian-style comments (`%% %%`), or even define your own!

### Tips

It's recommended to replace the existing keybinding for Obsidian's comment toggling command with the one provided by this plugin:

- ⌘+/ (Mac)

- Ctrl+/ (Windows)

## Support

This plugin is totally free to use! I have a lot of fun making stuff like this, so I never expect any type of financial compensation. But if you enjoy the plugin and are feeling generous, I certainly won't say no to a cup of coffee!