florianwoelki / obsidian-symbols-prettifier Goto Github PK

View Code? Open in Web Editor NEW

23.0 4.0 3.0 913 KB

Symbols that prettify your knowledge base.

License: MIT License

JavaScript 25.75% TypeScript 71.13% CSS 3.12%

obsidian obsidian-community obsidian-md obsidian-plugin prettifier symbols

obsidian-symbols-prettifier's Introduction

Obsidian Symbols Prettifier

What is it

Did you ever want to prettify your arrows or symbols, like -> or <=>?

With the help of this plugin, it is easier than ever before. This plugin allows you to prettify several character combinations so that these combinations do not look like cryptic symbols.

How to use

The easiest way to use the plugin is to install it and then try to type the following symbols. All of these symbols will be prettified:

->, <-, <->, <=>, <=, =>, ?unclear, !important

Development

To customize this project for your needs, you can clone it and then install all dependencies:

$ git clone https://github.com/FlorianWoelki/obsidian-symbols-prettifier
$ cd obsidian-symbols-prettifier
$ yarn

After the installation, you need to create a env.mjs file in the root directory. Fill the file with the following content:

export const obsidianExportPath =
  '<path-to-obsidian-vault>/.obsidian/plugins/obsidian-symbols-prettifier';

Afterward, you can start the rollup dev server by using:

$ yarn dev

This command will automatically build the necessary files for testing and developing every change. Furthermore, it copies all the essential files to the specified plugin directory.

Finally, you can customize the plugin and add it to your plugins.

obsidian-symbols-prettifier's People

Contributors

Stargazers

Watchers

Forkers

sharshuv-quotient lilianmallardeau hanjaejoon

obsidian-symbols-prettifier's Issues

Not working?

Hm, when I put in these signs in a note

->
<-
<->
<=>
<=
=>
?unclear
!important

there is no difference, even when I restart Obsidian.

I don't see the plugin in the list.

Windows 10, latest plugin

typing `constructor` inserts HTML and replaces with `undefined`

When you type constructor and hit space, the following content gets inserted over the word constructor.

I would expect the word constructor to be unchanged.

btw thanks for making this plugin, it's been very nice to use until hitting this weird bug!

Create prettifying for `?unclear` and `!important`

As a user, I would like to mark specific sections of my document with symbols like ?unclear or !important that act like badges and are visible in the document.

Provide screenshots / images

Visuals of the effects would help users decide whether to install this plugin or not, because they will help improve understanding of what exactly does this plugin do.

Options for shorthands to be off in coding blocks?

This plugin is brilliant and makes everything look great.

I have a request that there be an option to turn it off inside codeblocks.
I say this because I was debugging a dataview codeblock that seemed perfect and I couldn't figure out what the problem was until I realised the => arrow had been shortened to a single icon. I really like the plugin but I have to turn it off for now because I use codeblocks a lot. I'm not sure what plugin it is (or maybe theme) but I have something that makes == and => and so on in code blocks appear as expected so this is even more redundant in code blocks for me.
Finally, if someone is typing in a codeblock, I doubt they want the icons they use to be automatically changed so I can't see the use case when inside a code block.

Please let me know if you disagree!

Create command for prettifying document

As a user, I would like to prettify a whole document where I inserted arrows or symbols used by the symbols-prettifier before I installed the plugin.

The implementation can be through a command that formats the opened document.

Not working for me anymore in Obsidian 1.5.11

Two days ago I updated Obsidian to version 1.5.11. Since then the Symbols Prettifier doesn't work anymore for me.
None of the symbols will get replaced on my site.

More Infos:

I did not update any of my other Community Plugins -> Update: Did update the Dataview Plugin a day ago
Noticed this only after the new Obsidian Update
Not working on Windows 10 and Windows 11
Used Community Plugins: Calendar, Dataview, Iconize, Reminder, Style Settings, Symbols Prettifier, Task Collector (TC), Templater
Used Theme: AnuPpuccin, AnuPpuccin Themes Extended with Atom used
Tried: Restartet Obsidian, removed Plugin, restarted Obsidian again, installed Plugin new
EDIT: Disabled all other Plugins and used the Minimal Theme, problem is still there
EDIT 2: Created a new Test vault, added only this Plugin, still not working

Strange behavior: One of my vaults, with another theme and plugins, but new Obsidian version, does still work as expected. I think this could be a DAU (user is the problem) problem, but not sure.

Love the plugin and hopefully someone could have a look into this! Thanks for the nice Plugin, already use Iconize from the developer :)

EDIT: Und Grüße aus Deutschland xD

Doesn't work inside canvases

Works great when you edit a regular note in its own window.
However, if you edit the note directly from inside a canvas it does not seem to work. Neither does it work on canvas cards (the ones that are not regular notes and just lives in the canvas).

Creates arrows inside inline code block

Hi,
Great job on the plugin, I really like what it does.
I only found 1 issue, the arrow is disabled when you are working inside a codeblock delimited by ```.
I then tried it inside an inline code block delimited by ` and it changes the characters => with the arrow.

This will be conflictual with the dataviewJS inline queries.

Would be great to deactivate the changes when you are inline.

Thanks !