Skip to content

Commit

Permalink
release: 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
RyotaUshio committed Nov 24, 2023
1 parent 6feb0fb commit dd35bfb
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 12 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

<a href="https://www.buymeacoffee.com/ryotaushio" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>

## Installation

You can find it in Obsidian's community plugins browser.
Expand All @@ -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!

<a href="https://www.buymeacoffee.com/ryotaushio" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit dd35bfb

Please sign in to comment.