https://github.com/florianwoelki/obsidian-symbols-prettifier

Symbols that prettify your knowledge base.
https://github.com/florianwoelki/obsidian-symbols-prettifier

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

Last synced: 17 days ago
JSON representation

Symbols that prettify your knowledge base.

• Host: GitHub
• URL: https://github.com/florianwoelki/obsidian-symbols-prettifier
• Owner: FlorianWoelki
• License: mit
• Created: 2022-07-27T08:53:56.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-20T08:22:29.000Z (4 months ago)
• Last Synced: 2024-10-15T07:28:59.764Z (29 days ago)
• Topics: obsidian, obsidian-community, obsidian-md, obsidian-plugin, prettifier, symbols
• Language: TypeScript
• Homepage:
• Size: 856 KB
• Stars: 34
• Watchers: 4
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Symbols Prettifier

![Preview Image](./assets/preview-image.png)

## 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:

```sh

$ 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:

```js

export const obsidianExportPath =

  '/.obsidian/plugins/obsidian-symbols-prettifier';

```

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

```sh

$ 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.