diff --git a/README.md b/README.md index b2bef70..c7734fe 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,6 @@ Thank you to those who shared their ideas on the [forum](https://forum.obsidian. > [!WARNING] > Make sure you understand [how this plugin works](#how-does-it-work) before using it. -## Support Development - -If you are enjoying this plugin, please consider supporting me by buying me a coffee! - -Buy Me A Coffee - ## Installation You can find it in Obsidian's community plugins browser. @@ -40,9 +34,25 @@ ${} ... {}$ These braces are then hidden so that you are not disturbed by them. -## Don't like the brace pollution? Don't worry! +And importantly, they are automatically deleted when you escape from `$...$`, so you don't need to worry messing up your notes with braces! -You can always safely clean up the braces by running the following commands: +> [!Note] +> If you're interested in what's going on under the hood, go to the plugin setting > Debug mode, and turn on "Disable decorations". + +But just in case, this plugin also offers the following commands to surely clean up the braces: - **Clean up braces in this note** - **Clean up braces in all the opened notes** + +## Reporting issues + +If you find something is not working well, please report it by [filing an issue](https://github.com/RyotaUshio/obsidian-inline-math/issues). Attatching the following information is highly appreciated: + +- The result of the "Show debug info" command +- Screen recording of what happened, with `Debug mode > Disable decorations` turned on. If possible, please visualize your keystroke with a tool like [KeyCastr](https://github.com/keycastr/keycastr). + +## Support Development + +If you are enjoying this plugin, please consider supporting me by buying me a coffee! + +Buy Me A Coffee diff --git a/manifest.json b/manifest.json index 9a8ede2..220c03a 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,7 @@ { "id": "inline-math", "name": "No more flickering inline math", - "version": "0.2.1", + "version": "0.3.0", "minAppVersion": "1.3.0", "description": "No longer disturbed by flickering inline math in Obsidian.", "author": "Ryota Ushio", diff --git a/package-lock.json b/package-lock.json index 1237be2..8f0b873 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "obsidian-inline-math", - "version": "0.2.1", + "version": "0.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "obsidian-inline-math", - "version": "0.2.1", + "version": "0.3.0", "license": "MIT", "dependencies": { "@codemirror/language": "^6.9.0", diff --git a/package.json b/package.json index 18e7ab1..7fcdb64 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "obsidian-inline-math", - "version": "0.2.1", + "version": "0.3.0", "description": "No longer disturbed by flickering inline math in Obsidian.", "main": "main.js", "scripts": {