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

Update README.md

Browse source
This commit is contained in:
Spencer Gouw 2023-08-23 07:13:08 -07:00 committed by GitHub
parent e54e2dc245
commit b43bd93d0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -1,6 +1,9 @@
# jelly-snippets # jelly-snippets
A simple text snippets plugin for Obsidian.md. A simple text snippets plugin for Obsidian.md.
## BEFORE UPDATING,READ:
If you have used an older version of this plugin (1.5) or below, updating to version 1.6 will erase your snippets. Backup your snippets before updating; I will update the plugin with a backup functionality later too in case I mess up again. Deepest apologies.
## What does it do? ## What does it do?
@ -76,7 +79,7 @@ It's since been incorporated back into [julia.vim](https://github.com/JuliaEdito
## Future Improvements/TODO ## Future Improvements/TODO
- [ ] Control characters in snippets (e.g. whitespace, particularly newlines? currently snippets are trimmed on both ends; should probably not trim spaces) - [ ] Control characters in snippets
- [ ] Semantic symbols in snippets (e.g. where does cursor go afterwards? a snippet with braces might benefit from placing the cursor inside...) - [ ] Semantic symbols in snippets (e.g. where does cursor go afterwards? a snippet with braces might benefit from placing the cursor inside...)
- [ ] Regex capabilities - [ ] Regex capabilities
- [ ] Bugfixes and auditing? - [ ] Bugfixes and auditing?
@ -85,4 +88,4 @@ It's since been incorporated back into [julia.vim](https://github.com/JuliaEdito
### Other caveats ### Other caveats
- The lhs of a snippet (currently) cannot have newlines in it. Snippets of that sort will simply fail to work; they'll register but never trigger. The reason why is because I only search from cursor to start of line for snippet text; this is efficient and simple. To fix, we'd have to look backwards from the cursor position and match with the lhs of the snippet. Probably not a hard update, but given that this use case is somewhat rare (imo), I have neglected it. Do submit an issue. EDIT: the issue was submitted. Time to get to work. - None right now, except that the maintainer of this plugin (me) is inexperienced and may break something. Keep your snippets safe if you write a lot of them.