@mnaoumov/create-obsidian-plugin 1.0.2 → 1.1.0

package/templates/docs-showcase/files/src/docs/plugins/editor/communicating-with-editor-extensions/01-intro.ts

@@ -0,0 +1,21 @@
+// Docs: Communicating with editor extensions
+// https://docs.obsidian.md/Plugins/Editor/Communicating+with+editor+extensions
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Communicating%20with%20editor%20extensions.md?plain=1#L5
+// 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 { EditorView } from '@codemirror/view';
+
+async function snippet(context: DocsContext) {
+  const view = await context.getMarkdownView();
+  {
+    // @ts-expect-error, not typed
+    const editorView = view.editor.cm as EditorView;
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet(context));
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/communicating-with-editor-extensions/03-state-field.ts

@@ -0,0 +1,32 @@
+// Docs: Communicating with editor extensions > State field
+// https://docs.obsidian.md/Plugins/Editor/Communicating+with+editor+extensions#State+field
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Communicating%20with%20editor%20extensions.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, DocsThis } from '../../../host.ts';
+import { EditorView } from '@codemirror/view';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    this.addCommand({
+    	id: 'example-editor-command',
+    	name: 'Example editor command',
+    	editorCallback: (editor, view) => {
+    		// @ts-expect-error, not typed
+    		const editorView = view.editor.cm as EditorView;
+
+    		editorView.dispatch({
+    			effects: [
+    				// ...
+    			],
+    		});
+    	},
+    });
+  }
+}
+
+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/editor/decorations/01-widgets.ts

@@ -0,0 +1,23 @@
+// Docs: Decorations > Providing decorations > Widgets
+// https://docs.obsidian.md/Plugins/Editor/Decorations#Widgets
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Decorations.md?plain=1#L60
+// 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 { EditorView, WidgetType } from '@codemirror/view';
+
+export class EmojiWidget extends WidgetType {
+  toDOM(view: EditorView): HTMLElement {
+    const div = document.createElement('span');
+
+    div.innerText = '👉';
+
+    return div;
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  context.report("Declares EmojiWidget. It compiles against the API, and there is nothing in it to run on its own.");
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/decorations/02-widgets.ts

@@ -0,0 +1,20 @@
+// Docs: Decorations > Providing decorations > Widgets (2)
+// https://docs.obsidian.md/Plugins/Editor/Decorations#Widgets
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Decorations.md?plain=1#L76
+// 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 { Decoration } from '@codemirror/view';
+import { EmojiWidget } from './01-widgets.ts';
+
+const decoration = Decoration.replace({
+  widget: new EmojiWidget()
+});
+
+export { decoration };
+
+export async function run(context: DocsContext): Promise<void> {
+  context.report("Declares decoration. It compiles against the API, and there is nothing in it to run on its own.");
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/decorations/04-state-fields.ts

@@ -0,0 +1,57 @@
+// Docs: Decorations > Providing decorations > State fields (2)
+// https://docs.obsidian.md/Plugins/Editor/Decorations#State+fields
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Decorations.md?plain=1#L95
+// 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 { syntaxTree } from '@codemirror/language';
+import {
+  Extension,
+  RangeSetBuilder,
+  StateField,
+  Transaction,
+} from '@codemirror/state';
+import {
+  Decoration,
+  DecorationSet,
+  EditorView,
+  WidgetType,
+} from '@codemirror/view';
+import { EmojiWidget } from './01-widgets.ts';
+
+export const emojiListField = StateField.define<DecorationSet>({
+  create(state): DecorationSet {
+    return Decoration.none;
+  },
+  update(oldState: DecorationSet, transaction: Transaction): DecorationSet {
+    const builder = new RangeSetBuilder<Decoration>();
+
+    syntaxTree(transaction.state).iterate({
+      enter(node) {
+        if (node.type.name.startsWith('list')) {
+          // Position of the '-' or the '*'.
+          const listCharFrom = node.from - 2;
+
+          builder.add(
+            listCharFrom,
+            listCharFrom + 1,
+            Decoration.replace({
+              widget: new EmojiWidget(),
+            })
+          );
+        }
+      },
+    });
+
+    return builder.finish();
+  },
+  provide(field: StateField<DecorationSet>): Extension {
+    return EditorView.decorations.from(field);
+  },
+});
+
+export async function run(context: DocsContext): Promise<void> {
+  context.toggleEditorExtension(emojiListField);
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/decorations/05-view-plugins.ts

@@ -0,0 +1,79 @@
+// Docs: Decorations > Providing decorations > View plugins
+// https://docs.obsidian.md/Plugins/Editor/Decorations#View+plugins
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Decorations.md?plain=1#L154
+// 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 { syntaxTree } from '@codemirror/language';
+import { RangeSetBuilder } from '@codemirror/state';
+import {
+  Decoration,
+  DecorationSet,
+  EditorView,
+  PluginSpec,
+  PluginValue,
+  ViewPlugin,
+  ViewUpdate,
+  WidgetType,
+} from '@codemirror/view';
+import { EmojiWidget } from './01-widgets.ts';
+
+class EmojiListPlugin implements PluginValue {
+  decorations: DecorationSet;
+
+  constructor(view: EditorView) {
+    this.decorations = this.buildDecorations(view);
+  }
+
+  update(update: ViewUpdate) {
+    if (update.docChanged || update.viewportChanged) {
+      this.decorations = this.buildDecorations(update.view);
+    }
+  }
+
+  destroy() {}
+
+  buildDecorations(view: EditorView): DecorationSet {
+    const builder = new RangeSetBuilder<Decoration>();
+
+    for (let { from, to } of view.visibleRanges) {
+      syntaxTree(view.state).iterate({
+        from,
+        to,
+        enter(node) {
+          if (node.type.name.startsWith('list')) {
+            // Position of the '-' or the '*'.
+            const listCharFrom = node.from - 2;
+
+            builder.add(
+              listCharFrom,
+              listCharFrom + 1,
+              Decoration.replace({
+                widget: new EmojiWidget(),
+              })
+            );
+          }
+        },
+      });
+    }
+
+    return builder.finish();
+  }
+}
+
+const pluginSpec: PluginSpec<EmojiListPlugin> = {
+  decorations: (value: EmojiListPlugin) => value.decorations,
+};
+
+export const emojiListPlugin = ViewPlugin.fromClass(
+  EmojiListPlugin,
+  pluginSpec
+);
+
+export { EmojiListPlugin, pluginSpec };
+
+export async function run(context: DocsContext): Promise<void> {
+  context.toggleEditorExtension(emojiListPlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/editor/01-intro.ts

@@ -0,0 +1,26 @@
+// Docs: Editor
+// https://docs.obsidian.md/Plugins/Editor/Editor
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Editor.md?plain=1#L7
+// 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);
+
+    // Make sure the user is editing a Markdown file.
+    if (view) {
+    	const cursor = view.editor.getCursor();
+
+    	// ...
+    }
+  }
+}
+
+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/editor/editor/03-replace-current-selection.ts

@@ -0,0 +1,26 @@
+// Docs: Editor > Replace current selection
+// https://docs.obsidian.md/Plugins/Editor/Editor#Replace+current+selection
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Editor.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 { Editor, Plugin } from 'obsidian';
+
+export default class ExamplePlugin extends Plugin {
+  async onload() {
+    this.addCommand({
+      id: 'convert-to-uppercase',
+      name: 'Convert to uppercase',
+      editorCallback: (editor: Editor) => {
+        const selection = editor.getSelection();
+        editor.replaceSelection(selection.toUpperCase());
+      },
+    });
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(ExamplePlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/markdown-post-processing/01-intro.ts

@@ -0,0 +1,39 @@
+// Docs: Markdown post processing
+// https://docs.obsidian.md/Plugins/Editor/Markdown+post+processing
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/Markdown%20post%20processing.md?plain=1#L5
+// 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';
+
+const ALL_EMOJIS: Record<string, string> = {
+  ':+1:': '👍',
+  ':sunglasses:': '😎',
+  ':smile:': '😄',
+};
+
+export default class ExamplePlugin extends Plugin {
+  async onload() {
+    this.registerMarkdownPostProcessor((element, context) => {
+      const codeblocks = element.findAll('code');
+
+      for (let codeblock of codeblocks) {
+        const text = codeblock.innerText.trim();
+        if (text[0] === ':' && text[text.length - 1] === ':') {
+          const emojiEl = codeblock.createSpan({
+            text: ALL_EMOJIS[text] ?? text,
+          });
+          codeblock.replaceWith(emojiEl);
+        }
+      }
+    });
+  }
+}
+
+export { ALL_EMOJIS };
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(ExamplePlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/state-fields/01-defining-state-effects.ts

@@ -0,0 +1,19 @@
+// Docs: State fields > Defining state effects
+// https://docs.obsidian.md/Plugins/Editor/State+fields#Defining+state+effects
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/State%20fields.md?plain=1#L20
+// 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 { StateEffect } from '@codemirror/state';
+
+const addEffect = StateEffect.define<number>();
+const subtractEffect = StateEffect.define<number>();
+const resetEffect = StateEffect.define();
+
+export { addEffect, subtractEffect, resetEffect };
+
+export async function run(context: DocsContext): Promise<void> {
+  context.report("Declares addEffect, subtractEffect, resetEffect. It compiles against the API, and there is nothing in it to run on its own.");
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/state-fields/02-defining-a-state-field.ts

@@ -0,0 +1,35 @@
+// Docs: State fields > Defining a state field
+// https://docs.obsidian.md/Plugins/Editor/State+fields#Defining+a+state+field
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/State%20fields.md?plain=1#L34
+// 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 { addEffect, resetEffect, subtractEffect } from './01-defining-state-effects.ts';
+import { EditorState, StateField, Transaction } from '@codemirror/state';
+
+export const calculatorField = StateField.define<number>({
+  create(state: EditorState): number {
+    return 0;
+  },
+  update(oldState: number, transaction: Transaction): number {
+    let newState = oldState;
+
+    for (let effect of transaction.effects) {
+      if (effect.is(addEffect)) {
+        newState += effect.value;
+      } else if (effect.is(subtractEffect)) {
+        newState -= effect.value;
+      } else if (effect.is(resetEffect)) {
+        newState = 0;
+      }
+    }
+
+    return newState;
+  },
+});
+
+export async function run(context: DocsContext): Promise<void> {
+  context.toggleEditorExtension(calculatorField);
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/state-fields/04-dispatching-state-effects.ts

@@ -0,0 +1,34 @@
+// Docs: State fields > Dispatching state effects (2)
+// https://docs.obsidian.md/Plugins/Editor/State+fields#Dispatching+state+effects
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/State%20fields.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 { addEffect, resetEffect, subtractEffect } from './01-defining-state-effects.ts';
+import { EditorView } from '@codemirror/view';
+
+export function add(view: EditorView, num: number) {
+  view.dispatch({
+    effects: [addEffect.of(num)],
+  });
+}
+
+export function subtract(view: EditorView, num: number) {
+  view.dispatch({
+    effects: [subtractEffect.of(num)],
+  });
+}
+
+export function reset(view: EditorView) {
+  view.dispatch({
+    effects: [resetEffect.of(null)],
+  });
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await add(await context.getEditorView(), 1), 'add()');
+  await context.showResult(await subtract(await context.getEditorView(), 1), 'subtract()');
+  await context.showResult(await reset(await context.getEditorView()), 'reset()');
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/state-management/01-state-changes.ts

@@ -0,0 +1,21 @@
+// Docs: State management > State changes
+// https://docs.obsidian.md/Plugins/Editor/State+management#State+changes
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/State%20management.md?plain=1#L10
+// 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) {
+  {
+    let note = '';
+    note = 'Heading'
+    note = '# Heading'
+    note = '## Heading' // How to undo this?
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet(context));
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/state-management/02-state-changes.ts

@@ -0,0 +1,23 @@
+// Docs: State management > State changes (2)
+// https://docs.obsidian.md/Plugins/Editor/State+management#State+changes
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/State%20management.md?plain=1#L28
+// 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 { ChangeSpec } from '@codemirror/state';
+
+async function snippet(context: DocsContext) {
+  {
+    const changes: ChangeSpec[] = [];
+
+    changes.push({ from: 0, insert: 'Heading' });
+    changes.push({ from: 0, insert: '# ' });
+    changes.push({ from: 0, insert: '#' });
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet(context));
+}

package/templates/docs-showcase/files/src/docs/plugins/editor/view-plugins/01-creating-a-view-plugin.ts

@@ -0,0 +1,36 @@
+// Docs: View plugins > Creating a view plugin
+// https://docs.obsidian.md/Plugins/Editor/View+plugins#Creating+a+view+plugin
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Editor/View%20plugins.md?plain=1#L19
+// 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 {
+  ViewUpdate,
+  PluginValue,
+  EditorView,
+  ViewPlugin,
+} from '@codemirror/view';
+
+class ExamplePlugin implements PluginValue {
+  constructor(view: EditorView) {
+    // ...
+  }
+
+  update(update: ViewUpdate) {
+    // ...
+  }
+
+  destroy() {
+    // ...
+  }
+}
+
+export const examplePlugin = ViewPlugin.fromClass(ExamplePlugin);
+
+export { ExamplePlugin };
+
+export async function run(context: DocsContext): Promise<void> {
+  context.toggleEditorExtension(examplePlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/events/01-intro.ts

@@ -0,0 +1,21 @@
+// Docs: Events
+// https://docs.obsidian.md/Plugins/Events
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Events.md?plain=1#L5
+// 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 ExamplePlugin extends Plugin {
+  async onload() {
+    this.registerEvent(this.app.vault.on('create', () => {
+      console.log('a new file has entered the arena')
+    }));
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(ExamplePlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/getting-started/anatomy-of-a-plugin/01-intro.ts

@@ -0,0 +1,22 @@
+// Docs: Anatomy of a plugin
+// https://docs.obsidian.md/Plugins/Getting+started/Anatomy+of+a+plugin
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Getting%20started/Anatomy%20of%20a%20plugin.md?plain=1#L3
+// 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 ExamplePlugin extends Plugin {
+  async onload() {
+    // Configure resources needed by the plugin.
+  }
+  onunload() {
+    // Release any resources configured by the plugin.
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(ExamplePlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/getting-started/anatomy-of-a-plugin/02-plugin-lifecycle.ts

@@ -0,0 +1,22 @@
+// Docs: Anatomy of a plugin > Plugin lifecycle
+// https://docs.obsidian.md/Plugins/Getting+started/Anatomy+of+a+plugin#Plugin+lifecycle
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Getting%20started/Anatomy%20of%20a%20plugin.md?plain=1#L29
+// 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 ExamplePlugin extends Plugin {
+  async onload() {
+    console.log('loading plugin')
+  }
+  onunload() {
+    console.log('unloading plugin')
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.toggleChildPlugin(ExamplePlugin);
+}

package/templates/docs-showcase/files/src/docs/plugins/getting-started/build-a-plugin/06-step-5-update-the-source-code.ts

@@ -0,0 +1,19 @@
+// Docs: Build a plugin > Step 5: Update the source code
+// https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin#Step+5%3A+Update+the+source+code
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Getting%20started/Build%20a%20plugin.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 } from '../../../host.ts';
+import { Notice, Plugin } from 'obsidian';
+
+async function snippet(context: DocsContext) {
+  {
+
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet(context));
+}

package/templates/docs-showcase/files/src/docs/plugins/getting-started/build-a-plugin/07-step-5-update-the-source-code.ts

@@ -0,0 +1,21 @@
+// Docs: Build a plugin > Step 5: Update the source code (2)
+// https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin#Step+5%3A+Update+the+source+code
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Getting%20started/Build%20a%20plugin.md?plain=1#L115
+// 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 { Notice } from 'obsidian';
+
+async function snippet(this: DocsThis, context: DocsContext) {
+  {
+    this.addRibbonIcon('dice', 'Greet', () => {
+      new Notice('Hello, world!');
+    });
+  }
+}
+
+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/getting-started/mobile-development/03-platform-specific-features.ts

@@ -0,0 +1,25 @@
+// Docs: Mobile development > Platform-specific features
+// https://docs.obsidian.md/Plugins/Getting+started/Mobile+development#Platform-specific+features
+// Source: https://github.com/obsidianmd/obsidian-developer-docs/blob/1c26772ac13d6e9870c865936d389fdfe694e742/en/Plugins/Getting%20started/Mobile%20development.md?plain=1#L44
+// 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 { Platform } from 'obsidian';
+
+async function snippet(context: DocsContext) {
+  {
+    if (Platform.isIosApp) {
+      // ...
+    }
+
+    if (Platform.isAndroidApp) {
+      // ...
+    }
+  }
+}
+
+export async function run(context: DocsContext): Promise<void> {
+  await context.showResult(await snippet(context));
+}