diff --git a/README.md b/README.md index 2f99591e..1c33a8e1 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,7 @@ ![templater_logo](./imgs/templater_logo.svg) -[Templater](https://github.com/SilentVoid13/Templater) is a template language that lets you insert **variables** and **functions** results into your [Obsidian](https://obsidian.md/) notes. It will also let you execute JavaScript code manipulating those variables and functions. - -## Demonstration - -![templater_demo](https://raw.githubusercontent.com/SilentVoid13/Templater/master/imgs/templater_demo.gif) +[Templater](https://github.com/SilentVoid13/Templater) is a template plugin for [Obsidian.md](https://obsidian.md/). It defines a templating language that lets you insert variables and functions results into your notes. It will also let you execute JavaScript code manipulating those variables and functions. ## Documentation @@ -18,19 +14,11 @@ Check out the complete [documentation](https://silentvoid13.github.io/Templater/ It can be dangerous to execute arbitrary JavaScript code or system commands from untrusted sources. Only run code / commands that you understand, from trusted sources. -Because [Obsidian](https://obsidian.md/) is an offline application, it can be dangerous **only if** you copy-paste and blindly use a code snippet / command / template from an untrusted source. - -## Template Showcase ? Questions ? Ideas ? Help ? +## Template Showcase / Questions / Ideas / Help Go to the [discussion](https://github.com/SilentVoid13/Templater/discussions) tab to ask and find this kind of things. -Don't be shy and share your templates created using [Templater](https://github.com/SilentVoid13/Templater) in the [Template Showcase](https://github.com/SilentVoid13/Templater/discussions/categories/templates-showcase) category. Use [gists](https://gist.github.com/) to share the template file. I'm curious of what the community has come up with, and I'm sure I'm not the only one. - -## Utilities - -A list of useful tools to use along [Templater](https://github.com/SilentVoid13/Templater): - -- If you want to bind a specific template to a specific hotkey, you can use the **[obsidian-hotkeys-for-templates](https://github.com/Vinzent03/obsidian-hotkeys-for-templates)** plugin. +Don't be shy and share your templates created using [Templater](https://github.com/SilentVoid13/Templater) in the [Template Showcase](https://github.com/SilentVoid13/Templater/discussions/categories/templates-showcase) category. Use [gists](https://gist.github.com/) to share the template file. ## Resources @@ -44,6 +32,7 @@ A list of useful resources about [Templater](https://github.com/SilentVoid13/Tem ## Alternatives +- https://github.com/chhoumann/quickadd - https://github.com/garyng/obsidian-temple - https://github.com/avirut/obsidian-metatemplates @@ -55,7 +44,7 @@ You can create an [issue](https://github.com/SilentVoid13/Templater/issues) to r You can make a [pull request](https://github.com/SilentVoid13/Templater/pulls) to contribute to this plugin development. -Go [here](https://silentvoid13.github.io/Templater/docs/internal-variables-functions/contribute) to get more information on how to develop a new internal variable / function. +Check [this](https://silentvoid13.github.io/Templater/docs/internal-variables-functions/contribute) to get more information on how to develop a new internal variable / function. ## License @@ -64,3 +53,7 @@ Go [here](https://silentvoid13.github.io/Templater/docs/internal-variables-funct ## Support If you want to support me and my work, you can [sponsor me on Github](https://github.com/sponsors/SilentVoid13) (preferred method) or donate something on [**Paypal**](https://www.paypal.com/donate?hosted_button_id=U2SRGAFYXT32Q). + +[![GitHub Sponsors](https://img.shields.io/github/sponsors/silentvoid13?style=social)](https://github.com/sponsors/silentvoid13) +[![Paypal](https://img.shields.io/badge/paypal-silentvoid13-yellow?style=social&logo=paypal)](https://www.paypal.com/donate?hosted_button_id=U2SRGAFYXT32Q) + diff --git a/imgs/templater_demo.gif b/imgs/templater_demo.gif deleted file mode 100644 index 65f7aeb4..00000000 Binary files a/imgs/templater_demo.gif and /dev/null differ