{"id":13708135,"url":"https://github.com/mihaiconstantin/obsidian-templater-scripts","last_synced_at":"2025-04-09T03:31:19.692Z","repository":{"id":168797280,"uuid":"644563679","full_name":"mihaiconstantin/obsidian-templater-scripts","owner":"mihaiconstantin","description":"Convenient user scripts around the Templater plugin for Obsidian.","archived":false,"fork":false,"pushed_at":"2023-06-04T18:14:55.000Z","size":568,"stargazers_count":16,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-03T22:25:19.131Z","etag":null,"topics":["automation","note-taking","obsidian","templater"],"latest_commit_sha":null,"homepage":"https://obsidian-scripts.mihaiconstantin.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mihaiconstantin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-23T19:34:07.000Z","updated_at":"2024-07-30T05:06:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"88702cf9-6f6c-49fe-b98b-826fe3472d73","html_url":"https://github.com/mihaiconstantin/obsidian-templater-scripts","commit_stats":null,"previous_names":["mihaiconstantin/obsidian-templater-scripts"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mihaiconstantin%2Fobsidian-templater-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mihaiconstantin%2Fobsidian-templater-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mihaiconstantin%2Fobsidian-templater-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mihaiconstantin%2Fobsidian-templater-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mihaiconstantin","download_url":"https://codeload.github.com/mihaiconstantin/obsidian-templater-scripts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223362250,"owners_count":17133067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","note-taking","obsidian","templater"],"created_at":"2024-08-02T22:01:56.990Z","updated_at":"2024-11-06T15:12:08.017Z","avatar_url":"https://github.com/mihaiconstantin.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\" style=\"line-height: 2\"\u003e\n    \u003ccode\u003eTemplater\u003c/code\u003e User Scripts \u003cbr\u003e\n    for \u003ccode\u003eObsidian\u003c/code\u003e\n    \u003cbr/\u003e\n\u003c/h1\u003e\n\n\u003c!-- badges: start --\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.repostatus.org/#active\"\u003e\u003cimg src=\"https://www.repostatus.org/badges/latest/active.svg\" alt=\"Repository status\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/mihaiconstantin/obsidian-templater-scripts/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/mihaiconstantin/obsidian-templater-scripts?display_name=tag\u0026sort=semver\" alt=\"GitHub version\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/mihaiconstantin/obsidian-templater-scripts/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/mihaiconstantin/obsidian-templater-scripts\" alt=\"GitHub issues\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/mihaiconstantin/obsidian-templater-scripts\"\u003e\u003cimg alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/mihaiconstantin/obsidian-templater-scripts?style=social\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003c!-- badges: end --\u003e\n\n## ℹ️ Description\n\nThis repository contains opinionated, but convenient, [user scripts] built\naround the [`Templater`] plugin for [`Obsidian`].\n\n## ⬇️ Installation\n\n### Prerequisites\n\nThe installation steps that follow below assume a couple of things:\n\n1. You have an [`Obsidian`] vault.\n2. You have already installed and enabled the [`Templater`] community plugin.\n3. You correctly registered your templates folder in the [`Templater`] settings.\n\nDepending on how you handle your vault, you can either use [`git`] to install\nthe user scripts in this repository, or you can manually download and place them\nin your vault.\n\n### The [`git`] way 💻\n\nAdd this repository as a [submodule] to your vault in a location of your choice.\nSuppose you want to add the submodule to the `Scripts` directory in the root of\nyour vault. In a terminal, you need to do the following:\n\n```bash\n# Change directory to the root of your vault.\ncd /path/to/your/vault\n\n# Add this repository as a submodule to your vault.\ngit submodule add https://github.com/mihaiconstantin/obsidian-templater-scripts.git Scripts\n```\n\nAt this point, you should have a `Scripts` directory in the root of your vault\nthat contains the contents of this repository.\n\n*Note.* In most cases, after executing the `git submodule` command above [`git`]\nwill automatically download the contents of the repository in the `Scripts`\ndirectory. However, if your [`git`] version is seriously outdated, you may need\nto explicitly initialize the submodule by executing the following command:\n\n```bash\n# Download the submodule contents.\ngit submodule update --init --recursive\n```\n\n### The manual way 👀\n\nDownload a `.zip` archive of this repository, unpack it, and copy the contents\nof the unpacked folder to a location of your choice in the [`Obsidian`] vault\n(e.g., in the `Scripts` folder in the root of your vault).\n\n### Registering the scripts ⚙️\n\nThe final step in the installation process is informing [`Templater`] about the\nlocation of the `Scripts` folder. You may want to check [this\nresource][templater-user-scripts] for more information. In a nutshell, you need\nto indicate in the [`Templater`] settings where the `Scripts` folder is located,\nas shown below:\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"95%\" src=\"docs/assets/register-scripts-folder.png\" alt=\"register scripts folder\"/\u003e\n\u003c/p\u003e\n\nAdditionally, you may also want to exclude this folder from the search results.\nTo do this, you need to add the `Scripts` folder to the list of excluded folders\nin the [`Obsidian`] settings, as shown below:\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"95%\" src=\"docs/assets/exclude-scripts-folder.png\" alt=\"exclude scripts folder\"/\u003e\n\u003c/p\u003e\n\nAt this point, you are ready to start using the scripts in this repository in\nyour templates.\n\n## 🚀 Features\n\nThis repository exposes several scripts to the [`Templater`] `tp` object. Each\nof the scripts are available as a property of the `tp.user` object in the\ncontext of a template. Below you can see a table with the available scripts and\na brief description. Check out the documentation for each script (i.e., via the\nlink) for more information and examples on how to use them.\n\n| 🔗 User Script                                            | Description                                                                                                              |\n| :------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |\n| [`prompt`](docs/prompt.md)                               | Prompts the user based on a configuration object.                                                                         |\n| [`makeNote`](docs/makeNote.md)                           | Create a new note from template in a specified location, or insert a template at the cursor, without automated prompting. |\n| [`makeNoteWithPrompting`](docs/makeNoteWithPrompting.md) | Create a new note from template in a specified location, or insert a template at the cursor, with automated prompting.    |\n\n## Contributing\n\nAny contributions, suggestions, or bug reports are welcome and greatly\nappreciated. Please open an [issue] or submit a [pull request].\n\n## ⚖️ License\n\nThis repository is licensed under the [MIT license](LICENSE).\n\n[user scripts]: https://silentvoid13.github.io/Templater/user-functions/overview.html\n[`Templater`]: https://silentvoid13.github.io/Templater/introduction.html\n[`Obsidian`]: https://obsidian.md/\n[`git`]: https://git-scm.com/\n[submodule]: https://github.blog/2016-02-01-working-with-submodules/\n[templater-user-scripts]: https://silentvoid13.github.io/Templater/user-functions/script-user-functions.html\n[issue]: https://github.com/mihaiconstantin/obsidian-templater-scripts/issues\n[pull request]: https://github.com/mihaiconstantin/obsidian-templater-scripts/pulls\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmihaiconstantin%2Fobsidian-templater-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmihaiconstantin%2Fobsidian-templater-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmihaiconstantin%2Fobsidian-templater-scripts/lists"}