Skip to content

Commit

Permalink
feat: updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
SilentVoid13 committed Nov 8, 2022
1 parent 79e2925 commit 8689da4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 16 deletions.
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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)

Binary file removed imgs/templater_demo.gif
Binary file not shown.

0 comments on commit 8689da4

Please sign in to comment.