obsidian-plugin/rabirabirara_obsidian-jelly-snippets
1
0
Fork 0
mirror of https://github.com/rabirabirara/obsidian-jelly-snippets.git synced 2026-07-22 07:30:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
23 commits 5 branches 10 tags 266 KiB
TypeScript 90.4%
JavaScript 9%
CSS 0.6%
Find a file
Spencer Gouw 06ced0a5a2 remove funding, register keydown for new windows 
From the feedback from maintainers.

To allow the plugin to work on popup windows, we register an event on
window open that registers the keydown DOM event implementing expand on
Space/Tab.

There may be a better solution.
2023-03-15 14:17:42 -07:00
.editorconfig First commit, search snippets done 2023-03-15 00:04:06 -07:00
.eslintignore First commit, search snippets done 2023-03-15 00:04:06 -07:00
.eslintrc First commit, search snippets done 2023-03-15 00:04:06 -07:00
.gitignore First commit, search snippets done 2023-03-15 00:04:06 -07:00
.npmrc First commit, search snippets done 2023-03-15 00:04:06 -07:00
esbuild.config.mjs First commit, search snippets done 2023-03-15 00:04:06 -07:00
LICENSE Create LICENSE 2023-03-15 00:14:59 -07:00
main.ts remove funding, register keydown for new windows 2023-03-15 14:17:42 -07:00
manifest.json remove funding, register keydown for new windows 2023-03-15 14:17:42 -07:00
package-lock.json First commit, search snippets done 2023-03-15 00:04:06 -07:00
package.json First commit, search snippets done 2023-03-15 00:04:06 -07:00
pnpm-lock.yaml First commit, search snippets done 2023-03-15 00:04:06 -07:00
README.md Update README.md 2023-03-15 03:42:08 -07:00
tsconfig.json First commit, search snippets done 2023-03-15 00:04:06 -07:00
version-bump.mjs First commit, search snippets done 2023-03-15 00:04:06 -07:00
versions.json First commit, search snippets done 2023-03-15 00:04:06 -07:00

README.md

jelly-snippets

A simple text snippets plugin for Obsidian.md.

What does it do?

Pretty simple. You probably have run into snippets before.

  1. Specify a mapping of snippet to replacement in the settings tab.

    snippet. |+| replacement!

  2. If the cursor is at the end of a snippet...

    snippet.<cursor here>

  3. ..then triggering the snippet conversion...

    snippet.<cursor here - TRIGGER!>

  4. ..will replace the snippet with its replacement!

    replacement!<cursor here>

Why?

I wanted to make a generic snippets plugin that operated on text and worked as I needed. There is an existing snippets plugin already, Text Snippets by ArianaKhit, but not only is the plugin code somewhat outdated and a little complex, it seems to use an older API.

One of my goals writing this was to write a simple plugin that used the API exactly as described by the unofficial docs and by vanilla Typescript. I also wanted to make the core functionality of the plugin more flexible, though of course I have yet to add certain features that would truly provide that.

Another motivation was that I wanted to make a plugin by which I could type in my personal note-taking syntax (called JellyNote); I originally was going to write a whole editor extension, but I eventually realized that I could implement it with snippets. So, I'll be adding features to this plugin as long as I need them for JellyNote syntax.

Future Improvements

  • Control characters in snippets (e.g. whitespace, particularly newlines? currently snippets are trimmed on both ends; should probably not trim spaces)
  • Semantic symbols in snippets (e.g. where does cursor go afterwards?)
  • Regex capabilities