mirror of
https://github.com/jacoblearned/obsidian-template-by-note-name.git
synced 2026-07-22 11:30:27 +00:00
0c13dae74d
* Add template on rename events, disabled by default Also consolidates rename and creation prepend logic to ensure we're always atomically reading the content of the notes for both create and rename events * Release 1.1.3
52 lines
9.9 KiB
HTML
52 lines
9.9 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>obsidian-template-by-note-name</title><meta name="description" content="Documentation for obsidian-template-by-note-name"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">obsidian-template-by-note-name</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>obsidian-template-by-note-name</h1></div><div class="tsd-panel tsd-typography"><a id="template-by-note-name" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Template by Note Name<a href="#template-by-note-name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://www.buymeacoffee.com/jacoblearned" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee" style="height: 40px !important;width: 150px !important;" ></a></p>
|
|
<p>This is a simple <a href="https://obsidian.md/" target="_blank" class="external">Obsidian</a> plugin to automatically template notes
|
|
based on their name when created or renamed. Users can template notes that match
|
|
their desired naming conventions with any template that exists in their
|
|
specified templates folder (including sub-folders).</p>
|
|
<p>Examples:</p>
|
|
<ul>
|
|
<li>Create notes that start with <code>Meeting</code> with the content of <code>Templates/meeting.md</code></li>
|
|
<li>Create notes that end with <code>Task</code> with the content of <code>Templates/task.md</code></li>
|
|
<li>Create notes that contain <code>Idea</code> with the content of <code>Templates/idea.md</code></li>
|
|
</ul>
|
|
<a id="features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Features<a href="#features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
<li><strong>Quicker templating</strong>: Automatically template notes based on their name at creation time</li>
|
|
<li><strong>Customizable</strong>: Users can create rules to template notes based on their personal naming conventions</li>
|
|
<li><strong>Multiple match options</strong>: Choose from prefix, suffix, or contains to template notes</li>
|
|
<li><strong>Optionally template on rename</strong>: Choose whether or not to template notes when they are renamed
|
|
If a note is renamed to a matching template, the template content will be prepended to the existing note.</li>
|
|
<li><strong>Case sensitivity options</strong>: Choose whether or not to match note names against rules in a case-sensitive manner</li>
|
|
</ul>
|
|
<a id="installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You can install the plugin via the Community Plugins tab within Obsidian or by <a href="https://obsidian.md/plugins?id=template-by-note-name" target="_blank" class="external">direct link here</a>.</p>
|
|
<a id="zettelkasten-inspiration" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Zettelkasten Inspiration<a href="#zettelkasten-inspiration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>While the plugin supports general usage beyond <a href="https://en.wikipedia.org/wiki/Zettelkasten" target="_blank" class="external">Zettelkasten</a>,
|
|
my primary motivation for building the plugin was quicker templating of notes in a Zettelkasten system.</p>
|
|
<p>In Zettelkasten, notes are generally one of three types: reference notes, literature notes, or permanent notes
|
|
(although many variations exist based on personal preference).</p>
|
|
<ul>
|
|
<li><strong>Reference notes</strong> contain information that is useful for reference, such as direct quotes from a source</li>
|
|
<li><strong>Literature notes</strong> contain concise summaries in your own words a key point or idea made in a reference note's source.</li>
|
|
<li><strong>Permanent notes</strong> contain fully-worked original thoughts or ideas inspired by one or more literature notes.</li>
|
|
</ul>
|
|
<p>To manage these, I prefix each note type with a different color emoji for easy visual identification within Obsidian:
|
|
🟦 for reference notes, 🟨 for literature notes, and 🟩 for permanent notes.</p>
|
|
<p>I then have a template for each note type in my <code>Templates</code> folder, for example <code>Templates/reference_note.md</code>:</p>
|
|
<pre><code class="txt">---
|
|
type: Note
|
|
tags:
|
|
- reference-note
|
|
- inbox
|
|
date:
|
|
source:
|
|
author(s):
|
|
reviewed: false
|
|
---
|
|
**Summary**:
|
|
|
|
**Highlights**:
|
|
</code><button type="button">Copy</button></pre>
|
|
|
|
<p>Using the plugin, it's simple to create new Zettelkasten notes that are already populated
|
|
with the Obsidian page properties I like to include for each note type.</p>
|
|
<p><img src="media/Zettelkasten.png" alt="alt text"></p>
|
|
<a id="settings" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Settings<a href="#settings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><img src="media/PluginSettingsScreenshot.png" alt="Plugin Settings"></p>
|
|
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#template-by-note-name"><span>Template by <wbr/>Note <wbr/>Name</span></a><ul><li><a href="#features"><span>Features</span></a></li><li><a href="#installation"><span>Installation</span></a></li><li><a href="#zettelkasten-inspiration"><span>Zettelkasten <wbr/>Inspiration</span></a></li><li><a href="#settings"><span>Settings</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current">obsidian-template-by-note-name</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|