@mnaoumov/create-obsidian-plugin 1.0.2 → 1.2.0

package/templates/docs-showcase/files/src/docs/plugins/getting-started/use-react-in-your-plugin/03-configure-your-plugin.ts

@@ -0,0 +1,23 @@
+// Docs: Use React in your plugin > Configure your plugin (3)
+// https://docs.obsidian.md/Plugins/Getting+started/Use+React+in+your+plugin#Configure+your+plugin
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Getting%20started/Use%20React%20in%20your%20plugin.md?plain=1#L25
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+
+async function snippet(context: DocsContext) {
+  const value = (
+    {
+      "compilerOptions": {
+        "jsx": "react-jsx"
+      }
+    }
+  );
+  await context.showResult(value);
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await snippet(context);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/build-a-bases-view/01-step-1-sample-plugin-setup.ts

@@ -0,0 +1,18 @@
+// Docs: Build a Bases view > Step 1: Sample plugin setup
+// https://docs.obsidian.md/Plugins/Guides/Build+a+Bases+view#Step+1%3A+Sample+plugin+setup
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Build%20a%20Bases%20view.md?plain=1#L37
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Plugin } from 'obsidian';
+
+export default class MyPlugin extends Plugin {
+  async onload() {
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/build-a-bases-view/02-step-2-create-and-register-the-bases-vie.ts

@@ -0,0 +1,46 @@
+// Docs: Build a Bases view > Step 2: Create and register the Bases view
+// https://docs.obsidian.md/Plugins/Guides/Build+a+Bases+view#Step+2%3A+Create+and+register+the+Bases+view
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Build%20a%20Bases%20view.md?plain=1#L48
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { BasesView, Plugin, QueryController } from 'obsidian';
+
+export const ExampleViewType = 'example-view';
+
+export default class MyPlugin extends Plugin {
+  async onload() {
+    // Tell Obsidian about the new view type that this plugin provides.
+    this.registerBasesView(ExampleViewType, {
+      name: 'Example',
+      icon: 'lucide-graduation-cap',
+      factory: (controller, containerEl) => {
+        return new MyBasesView(controller, containerEl)
+      },
+    });
+  }
+}
+
+export class MyBasesView extends BasesView {
+  readonly type = ExampleViewType;
+  private containerEl: HTMLElement;
+
+  constructor(controller: QueryController, parentEl: HTMLElement) {
+    super(controller);
+    this.containerEl = parentEl.createDiv('bases-example-view-container');
+  }
+
+  // onDataUpdated is called by Obsidian whenever there is a configuration
+  // or data change in the vault which may affect your view. For now,
+  // simply draw "Hello World" to screen.
+  public onDataUpdated(): void {
+    this.containerEl.empty();
+    this.containerEl.createDiv({ text: 'Hello World' });
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/build-a-bases-view/03-step-3-add-configuration.ts

@@ -0,0 +1,40 @@
+// Docs: Build a Bases view > Step 3: Add configuration
+// https://docs.obsidian.md/Plugins/Guides/Build+a+Bases+view#Step+3%3A+Add+configuration
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Build%20a%20Bases%20view.md?plain=1#L91
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { ExampleViewType, MyBasesView } from './02-step-2-create-and-register-the-bases-vie.ts';
+import { Plugin } from 'obsidian';
+
+export default class MyPlugin extends Plugin {
+  async onload() {
+    // Tell Obsidian about the new view type that this plugin provides.
+    this.registerBasesView(ExampleViewType, {
+      name: "Example",
+      icon: 'lucide-graduation-cap',
+      factory: (controller, containerEl) => {
+        return new MyBasesView(controller, containerEl)
+      },
+      options: () => ([
+        {
+          // The type of option. 'text' is a text input.
+          type: 'text',
+          // The name displayed in the settings menu.
+          displayName: 'Property separator',
+          // The value saved to the view settings.
+          key: 'separator',
+          // The default value for this option.
+          default: ' - ',
+        },
+        // ...
+    ]),
+    });
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/defer-views/04-accessing-your-customview-without-reveal.ts

@@ -0,0 +1,26 @@
+// Docs: Defer views > Accessing your CustomView without reveal (Advanced)
+// https://docs.obsidian.md/Plugins/Guides/Defer+views#Accessing+your+%60CustomView%60+without+reveal+(Advanced)
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Defer%20views.md?plain=1#L74
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { requireApiVersion } from 'obsidian';
+
+async function snippet(context: DocsContext) {
+  const workspace = context.app.workspace;
+  {
+    let leaves = workspace.getLeavesOfType('my-view');
+    for (let leaf of leaves) {
+      if (requireApiVersion('1.7.2')) {
+        await leaf.loadIfDeferred(); // Ensure view is fully loaded
+      }
+      // perform modifications here...
+    }
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet(context));
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/01-overview.ts

@@ -0,0 +1,26 @@
+// Docs: Manage plugin lifecycle > Overview
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Overview
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L23
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Plugin } from 'obsidian';
+
+// Bad: the listener is never removed!
+class MyPlugin extends Plugin {
+	onResize() {
+		console.debug("Window resized!");
+	}
+
+	onload() {
+		window.addEventListener("resize", this.onResize);
+	}
+}
+
+export { MyPlugin };
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/02-overview.ts

@@ -0,0 +1,30 @@
+// Docs: Manage plugin lifecycle > Overview (2)
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Overview
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L40
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Plugin } from 'obsidian';
+
+// Better: but more tedious and error-prone.
+class MyPlugin extends Plugin {
+	onResize() {
+		console.debug("Window resized!");
+	}
+
+	onload() {
+		window.addEventListener("resize", this.onResize);
+	}
+
+	onunload() {
+		window.removeEventListener("resize", this.onResize);
+	}
+}
+
+export { MyPlugin };
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/03-automatic-resource-management-with-compo.ts

@@ -0,0 +1,26 @@
+// Docs: Manage plugin lifecycle > Automatic Resource Management with Component
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Automatic+Resource+Management+with+%60Component%60
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L65
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Plugin } from 'obsidian';
+
+// Best: the listener is automatically cleaned up!
+class MyPlugin extends Plugin {
+	onResize() {
+		console.debug("Window resized!");
+	}
+
+	onload() {
+		this.registerDomEvent(window, "resize", this.onResize);
+	}
+}
+
+export { MyPlugin };
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/04-registerevent-eventref.ts

@@ -0,0 +1,22 @@
+// Docs: Manage plugin lifecycle > Automatic Resource Management with Component > registerEvent(eventRef)
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#%60registerEvent(eventRef)%60
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L86
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    this.registerEvent(
+    	this.app.vault.on("modify", (file) => {
+    		console.debug("File modified:", file.path);
+    	})
+    );
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/05-registerinterval-id.ts

@@ -0,0 +1,21 @@
+// Docs: Manage plugin lifecycle > Automatic Resource Management with Component > registerInterval(id)
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#%60registerInterval(id)%60
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L98
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    const id = window.setInterval(() => {
+    	console.debug("Periodic task running...");
+    }, 1000);
+    this.registerInterval(id);
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/06-registerdomevent-el-event-handler.ts

@@ -0,0 +1,20 @@
+// Docs: Manage plugin lifecycle > Automatic Resource Management with Component > registerDomEvent(el, event, handler)
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#%60registerDomEvent(el%2C+event%2C+handler)%60
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L109
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    this.registerDomEvent(window, "resize", () => {
+    	console.debug("Window resized!");
+    });
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/08-understanding-the-lifecycle-of-objects.ts

@@ -0,0 +1,29 @@
+// Docs: Manage plugin lifecycle > Understanding The Lifecycle of Objects (2)
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Understanding+The+Lifecycle+of+Objects
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L160
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Modal } from 'obsidian';
+
+class MyModal extends Modal {
+	onKeyDown() {
+		console.debug("Key pressed!");
+	}
+
+	onOpen() {
+		window.addEventListener("keydown", this.onKeyDown);
+	}
+
+	onClose() {
+		window.removeEventListener("keydown", this.onKeyDown);
+	}
+}
+
+export { MyModal };
+
+export async function run(context: DocsContext): Promise<void> {
+  context.openModal(new MyModal(context.app));
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/manage-plugin-lifecycle/14-componentized-modal-example.ts

@@ -0,0 +1,37 @@
+// Docs: Manage plugin lifecycle > Creating Your Own Components > Componentized Modal Example
+// https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Componentized+Modal+Example
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Manage%20plugin%20lifecycle.md?plain=1#L349
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { App, Component, Modal } from 'obsidian';
+
+class MyModal extends Modal {
+	private component: Component;
+
+	public constructor(app: App) {
+		super(app);
+		this.component = new Component();
+		this.component.load();
+	}
+
+	onOpen() {
+		// Register the keyboard event on the component
+		this.component.registerDomEvent(window, "keydown", (evt) => {
+			console.debug("Key pressed:", evt.key);
+		});
+	}
+
+	onClose() {
+		// Manually unload the component, which removes the listener
+		this.component.unload();
+	}
+}
+
+export { MyModal };
+
+export async function run(context: DocsContext): Promise<void> {
+  context.openModal(new MyModal(context.app));
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/optimize-plugin-load-time/01-option-a-check-if-the-layout-is-ready.ts

@@ -0,0 +1,29 @@
+// Docs: Optimize plugin load time > Pitfalls > Listening to vault.on('create') > Option A. Check if the layout is ready
+// https://docs.obsidian.md/Plugins/Guides/Optimize+plugin+load+time#Option+A.+Check+if+the+layout+is+ready
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Optimize%20plugin%20load%20time.md?plain=1#L36
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Plugin } from 'obsidian';
+
+class MyPlugin extends Plugin {
+    onload() {
+        this.registerEvent(this.app.vault.on('create', this.onCreate, this));
+    }
+
+	onCreate() {
+	    if (!this.app.workspace.layoutReady) {
+	      // Workspace is still loading, do nothing
+	      return;
+	    }
+		// ...
+	}
+}
+
+export { MyPlugin };
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/optimize-plugin-load-time/02-option-b-register-the-handler-once-the-l.ts

@@ -0,0 +1,27 @@
+// Docs: Optimize plugin load time > Pitfalls > Listening to vault.on('create') > Option B. Register the handler once the layout is ready
+// https://docs.obsidian.md/Plugins/Guides/Optimize+plugin+load+time#Option+B.+Register+the+handler+once+the+layout+is+ready
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Optimize%20plugin%20load%20time.md?plain=1#L54
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Plugin } from 'obsidian';
+
+class MyPlugin extends Plugin {
+    onload() {
+	    this.app.workspace.onLayoutReady(() => {
+	        this.registerEvent(this.app.vault.on('create', this.onCreate, this));
+	    });
+    }
+
+	onCreate() {
+		// ...
+	}
+}
+
+export { MyPlugin };
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/guides/store-secrets/03-step-3-retrieve-the-secret-value.ts

@@ -0,0 +1,22 @@
+// Docs: Store secrets > Step 3: Retrieve the secret value
+// https://docs.obsidian.md/Plugins/Guides/Store+secrets#Step+3%3A+Retrieve+the+secret+value
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Guides/Store%20secrets.md?plain=1#L89
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  const app = context.app;
+  {
+    const secret = app.secretStorage.getSecret(this.settings.mySetting);
+    if (secret) { // secret value might be null
+
+    }
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/releasing/plugin-guidelines/01-use-setheading-instead-of-a-h1-h2.ts

@@ -0,0 +1,20 @@
+// Docs: Plugin guidelines > UI text > Use setHeading instead of a <h1>, <h2>
+// https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Use+%60setHeading%60+instead+of+a+%60%3Ch1%3E%60%2C+%60%3Ch2%3E%60
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Releasing/Plugin%20guidelines.md?plain=1#L73
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Setting } from 'obsidian';
+
+async function snippet(context: DocsContext) {
+  const containerEl = context.getContainerEl();
+  {
+    new Setting(containerEl).setName('your heading title').setHeading();
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet(context));
+}

package/templates/docs-showcase/files/src/docs/plugins/releasing/plugin-guidelines/03-clean-up-resources-when-plugin-unloads.ts

@@ -0,0 +1,23 @@
+// Docs: Plugin guidelines > Resource management > Clean up resources when plugin unloads
+// https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Clean+up+resources+when+plugin+unloads
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Releasing/Plugin%20guidelines.md?plain=1#L104
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { Plugin, TAbstractFile } from 'obsidian';
+
+export default class MyPlugin extends Plugin {
+  onload() {
+    this.registerEvent(this.app.vault.on('create', this.onCreate));
+  }
+
+  onCreate = (file: TAbstractFile) => {
+    // ...
+  };
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(MyPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/releasing/plugin-guidelines/04-avoid-accessing-workspace-activeleaf-dir.ts

@@ -0,0 +1,24 @@
+// Docs: Plugin guidelines > Workspace > Avoid accessing workspace.activeLeaf directly
+// https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+accessing+%60workspace.activeLeaf%60+directly
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Releasing/Plugin%20guidelines.md?plain=1#L146
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+import { MarkdownView } from 'obsidian';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    const view = this.app.workspace.getActiveViewOfType(MarkdownView);
+
+    // getActiveViewOfType will return null if the active view is null, or if it's not a MarkdownView.
+    if (view) {
+      // ...
+    }
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/releasing/plugin-guidelines/05-avoid-accessing-workspace-activeleaf-dir.ts

@@ -0,0 +1,22 @@
+// Docs: Plugin guidelines > Workspace > Avoid accessing workspace.activeLeaf directly (2)
+// https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+accessing+%60workspace.activeLeaf%60+directly
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Releasing/Plugin%20guidelines.md?plain=1#L157
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    const editor = this.app.workspace.activeEditor?.editor;
+
+    if (editor) {
+        // ...
+    }
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/releasing/plugin-guidelines/10-avoid-iterating-all-files-to-find-a-file.ts

@@ -0,0 +1,20 @@
+// Docs: Plugin guidelines > Vault > Avoid iterating all files to find a file by its path (2)
+// https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+iterating+all+files+to+find+a+file+by+its+path
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Releasing/Plugin%20guidelines.md?plain=1#L236
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    const filePath = 'folder/file.md';
+    // if you want to get a file
+    const file = this.app.vault.getFileByPath(filePath);
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/releasing/plugin-guidelines/11-avoid-iterating-all-files-to-find-a-file.ts

@@ -0,0 +1,20 @@
+// Docs: Plugin guidelines > Vault > Avoid iterating all files to find a file by its path (3)
+// https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+iterating+all+files+to+find+a+file+by+its+path
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Releasing/Plugin%20guidelines.md?plain=1#L242
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext, DocsThis } from '../../../host.ts';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    const folderPath = 'folder';
+    // or if you want to get a folder
+    const folder = this.app.vault.getFolderByPath(folderPath);
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet.call(context.thisValue(), context));
+}

package/templates/docs-showcase/files/src/docs/plugins/releasing/plugin-guidelines/13-use-normalizepath-to-clean-up-user-defin.ts

@@ -0,0 +1,18 @@
+// Docs: Plugin guidelines > Vault > Use normalizePath() to clean up user-defined paths
+// https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Use+%60normalizePath()%60+to+clean+up+user-defined+paths
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Releasing/Plugin%20guidelines.md?plain=1#L271
+// The code block is licensed under 0BSD (code examples of obsidianmd/obsidian-developer-docs, Copyright (C) 2020-2026 Dynalist Inc.).
+// The code block is upstream's, as the docs show it. create-obsidian-plugin generated the rest: the imports it
+// leaves out, the exports later blocks on the page take, and the `run(context)` host the command calls.
+
+import type { DocsContext } from '../../../host.ts';
+import { normalizePath } from 'obsidian';
+
+const pathToPlugin = normalizePath('//my-folder\file');
+// pathToPlugin contains "my-folder/file" not "//my-folder\"
+
+export { pathToPlugin };
+
+export async function run(context: DocsContext): Promise<void> {
+  context.report("Declares pathToPlugin. It compiles against the API, and there is nothing in it to run on its own.");
+}