@mnaoumov/create-obsidian-plugin 1.0.1 → 1.1.0

package/templates/docs-showcase/files/src/docs/index.ts

@@ -0,0 +1,699 @@
+// Generated by create-obsidian-plugin from the Obsidian developer docs. One command per runnable code block;
+// `README.md` in this folder lists every block, including the ones that are not here and why.
+
+import type { Plugin } from 'obsidian';
+
+import type { DocsEntry } from './host.ts';
+
+import { registerDocsEntries } from './host.ts';
+
+const ENTRIES: DocsEntry[] = [
+  {
+    id: "plugins-editor-communicating-with-editor-extensions-01",
+    load: () => import("./plugins/editor/communicating-with-editor-extensions/01-intro.ts"),
+    name: "Communicating with editor extensions",
+    source: "https://docs.obsidian.md/Plugins/Editor/Communicating+with+editor+extensions"
+  },
+  {
+    id: "plugins-editor-communicating-with-editor-extensions-03",
+    load: () => import("./plugins/editor/communicating-with-editor-extensions/03-state-field.ts"),
+    name: "Communicating with editor extensions > State field",
+    source: "https://docs.obsidian.md/Plugins/Editor/Communicating+with+editor+extensions#State+field"
+  },
+  {
+    id: "plugins-editor-decorations-01",
+    load: () => import("./plugins/editor/decorations/01-widgets.ts"),
+    name: "Decorations > Providing decorations > Widgets",
+    source: "https://docs.obsidian.md/Plugins/Editor/Decorations#Widgets"
+  },
+  {
+    id: "plugins-editor-decorations-02",
+    load: () => import("./plugins/editor/decorations/02-widgets.ts"),
+    name: "Decorations > Providing decorations > Widgets (2)",
+    source: "https://docs.obsidian.md/Plugins/Editor/Decorations#Widgets"
+  },
+  {
+    id: "plugins-editor-decorations-04",
+    load: () => import("./plugins/editor/decorations/04-state-fields.ts"),
+    name: "Decorations > Providing decorations > State fields (2)",
+    source: "https://docs.obsidian.md/Plugins/Editor/Decorations#State+fields"
+  },
+  {
+    id: "plugins-editor-decorations-05",
+    load: () => import("./plugins/editor/decorations/05-view-plugins.ts"),
+    name: "Decorations > Providing decorations > View plugins",
+    source: "https://docs.obsidian.md/Plugins/Editor/Decorations#View+plugins"
+  },
+  {
+    id: "plugins-editor-editor-01",
+    load: () => import("./plugins/editor/editor/01-intro.ts"),
+    name: "Editor",
+    source: "https://docs.obsidian.md/Plugins/Editor/Editor"
+  },
+  {
+    id: "plugins-editor-editor-03",
+    load: () => import("./plugins/editor/editor/03-replace-current-selection.ts"),
+    name: "Editor > Replace current selection",
+    source: "https://docs.obsidian.md/Plugins/Editor/Editor#Replace+current+selection"
+  },
+  {
+    id: "plugins-editor-markdown-post-processing-01",
+    load: () => import("./plugins/editor/markdown-post-processing/01-intro.ts"),
+    name: "Markdown post processing",
+    source: "https://docs.obsidian.md/Plugins/Editor/Markdown+post+processing"
+  },
+  {
+    id: "plugins-editor-state-fields-01",
+    load: () => import("./plugins/editor/state-fields/01-defining-state-effects.ts"),
+    name: "State fields > Defining state effects",
+    source: "https://docs.obsidian.md/Plugins/Editor/State+fields#Defining+state+effects"
+  },
+  {
+    id: "plugins-editor-state-fields-02",
+    load: () => import("./plugins/editor/state-fields/02-defining-a-state-field.ts"),
+    name: "State fields > Defining a state field",
+    source: "https://docs.obsidian.md/Plugins/Editor/State+fields#Defining+a+state+field"
+  },
+  {
+    id: "plugins-editor-state-fields-04",
+    load: () => import("./plugins/editor/state-fields/04-dispatching-state-effects.ts"),
+    name: "State fields > Dispatching state effects (2)",
+    source: "https://docs.obsidian.md/Plugins/Editor/State+fields#Dispatching+state+effects"
+  },
+  {
+    id: "plugins-editor-state-management-01",
+    load: () => import("./plugins/editor/state-management/01-state-changes.ts"),
+    name: "State management > State changes",
+    source: "https://docs.obsidian.md/Plugins/Editor/State+management#State+changes"
+  },
+  {
+    id: "plugins-editor-state-management-02",
+    load: () => import("./plugins/editor/state-management/02-state-changes.ts"),
+    name: "State management > State changes (2)",
+    source: "https://docs.obsidian.md/Plugins/Editor/State+management#State+changes"
+  },
+  {
+    id: "plugins-editor-view-plugins-01",
+    load: () => import("./plugins/editor/view-plugins/01-creating-a-view-plugin.ts"),
+    name: "View plugins > Creating a view plugin",
+    source: "https://docs.obsidian.md/Plugins/Editor/View+plugins#Creating+a+view+plugin"
+  },
+  {
+    id: "plugins-events-01",
+    load: () => import("./plugins/events/01-intro.ts"),
+    name: "Events",
+    source: "https://docs.obsidian.md/Plugins/Events"
+  },
+  {
+    id: "plugins-getting-started-anatomy-of-a-plugin-01",
+    load: () => import("./plugins/getting-started/anatomy-of-a-plugin/01-intro.ts"),
+    name: "Anatomy of a plugin",
+    source: "https://docs.obsidian.md/Plugins/Getting+started/Anatomy+of+a+plugin"
+  },
+  {
+    id: "plugins-getting-started-anatomy-of-a-plugin-02",
+    load: () => import("./plugins/getting-started/anatomy-of-a-plugin/02-plugin-lifecycle.ts"),
+    name: "Anatomy of a plugin > Plugin lifecycle",
+    source: "https://docs.obsidian.md/Plugins/Getting+started/Anatomy+of+a+plugin#Plugin+lifecycle"
+  },
+  {
+    id: "plugins-getting-started-build-a-plugin-06",
+    load: () => import("./plugins/getting-started/build-a-plugin/06-step-5-update-the-source-code.ts"),
+    name: "Build a plugin > Step 5: Update the source code",
+    source: "https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin#Step+5%3A+Update+the+source+code"
+  },
+  {
+    id: "plugins-getting-started-build-a-plugin-07",
+    load: () => import("./plugins/getting-started/build-a-plugin/07-step-5-update-the-source-code.ts"),
+    name: "Build a plugin > Step 5: Update the source code (2)",
+    source: "https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin#Step+5%3A+Update+the+source+code"
+  },
+  {
+    id: "plugins-getting-started-mobile-development-03",
+    load: () => import("./plugins/getting-started/mobile-development/03-platform-specific-features.ts"),
+    name: "Mobile development > Platform-specific features",
+    source: "https://docs.obsidian.md/Plugins/Getting+started/Mobile+development#Platform-specific+features"
+  },
+  {
+    id: "plugins-getting-started-use-react-in-your-plugin-03",
+    load: () => import("./plugins/getting-started/use-react-in-your-plugin/03-configure-your-plugin.ts"),
+    name: "Use React in your plugin > Configure your plugin (3)",
+    source: "https://docs.obsidian.md/Plugins/Getting+started/Use+React+in+your+plugin#Configure+your+plugin"
+  },
+  {
+    id: "plugins-guides-build-a-bases-view-01",
+    load: () => import("./plugins/guides/build-a-bases-view/01-step-1-sample-plugin-setup.ts"),
+    name: "Build a Bases view > Step 1: Sample plugin setup",
+    source: "https://docs.obsidian.md/Plugins/Guides/Build+a+Bases+view#Step+1%3A+Sample+plugin+setup"
+  },
+  {
+    id: "plugins-guides-build-a-bases-view-02",
+    load: () => import("./plugins/guides/build-a-bases-view/02-step-2-create-and-register-the-bases-vie.ts"),
+    name: "Build a Bases view > Step 2: Create and register the Bases view",
+    source: "https://docs.obsidian.md/Plugins/Guides/Build+a+Bases+view#Step+2%3A+Create+and+register+the+Bases+view"
+  },
+  {
+    id: "plugins-guides-build-a-bases-view-03",
+    load: () => import("./plugins/guides/build-a-bases-view/03-step-3-add-configuration.ts"),
+    name: "Build a Bases view > Step 3: Add configuration",
+    source: "https://docs.obsidian.md/Plugins/Guides/Build+a+Bases+view#Step+3%3A+Add+configuration"
+  },
+  {
+    id: "plugins-guides-defer-views-04",
+    load: () => import("./plugins/guides/defer-views/04-accessing-your-customview-without-reveal.ts"),
+    name: "Defer views > Accessing your CustomView without reveal (Advanced)",
+    source: "https://docs.obsidian.md/Plugins/Guides/Defer+views#Accessing+your+%60CustomView%60+without+reveal+(Advanced)"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-01",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/01-overview.ts"),
+    name: "Manage plugin lifecycle > Overview",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Overview"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-02",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/02-overview.ts"),
+    name: "Manage plugin lifecycle > Overview (2)",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Overview"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-03",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/03-automatic-resource-management-with-compo.ts"),
+    name: "Manage plugin lifecycle > Automatic Resource Management with Component",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Automatic+Resource+Management+with+%60Component%60"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-04",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/04-registerevent-eventref.ts"),
+    name: "Manage plugin lifecycle > Automatic Resource Management with Component > registerEvent(eventRef)",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#%60registerEvent(eventRef)%60"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-05",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/05-registerinterval-id.ts"),
+    name: "Manage plugin lifecycle > Automatic Resource Management with Component > registerInterval(id)",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#%60registerInterval(id)%60"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-06",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/06-registerdomevent-el-event-handler.ts"),
+    name: "Manage plugin lifecycle > Automatic Resource Management with Component > registerDomEvent(el, event, handler)",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#%60registerDomEvent(el%2C+event%2C+handler)%60"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-08",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/08-understanding-the-lifecycle-of-objects.ts"),
+    name: "Manage plugin lifecycle > Understanding The Lifecycle of Objects (2)",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Understanding+The+Lifecycle+of+Objects"
+  },
+  {
+    id: "plugins-guides-manage-plugin-lifecycle-14",
+    load: () => import("./plugins/guides/manage-plugin-lifecycle/14-componentized-modal-example.ts"),
+    name: "Manage plugin lifecycle > Creating Your Own Components > Componentized Modal Example",
+    source: "https://docs.obsidian.md/Plugins/Guides/Manage+plugin+lifecycle#Componentized+Modal+Example"
+  },
+  {
+    id: "plugins-guides-optimize-plugin-load-time-01",
+    load: () => import("./plugins/guides/optimize-plugin-load-time/01-option-a-check-if-the-layout-is-ready.ts"),
+    name: "Optimize plugin load time > Pitfalls > Listening to vault.on('create') > Option A. Check if the layout is ready",
+    source: "https://docs.obsidian.md/Plugins/Guides/Optimize+plugin+load+time#Option+A.+Check+if+the+layout+is+ready"
+  },
+  {
+    id: "plugins-guides-optimize-plugin-load-time-02",
+    load: () => import("./plugins/guides/optimize-plugin-load-time/02-option-b-register-the-handler-once-the-l.ts"),
+    name: "Optimize plugin load time > Pitfalls > Listening to vault.on('create') > Option B. Register the handler once the layout is ready",
+    source: "https://docs.obsidian.md/Plugins/Guides/Optimize+plugin+load+time#Option+B.+Register+the+handler+once+the+layout+is+ready"
+  },
+  {
+    id: "plugins-guides-store-secrets-03",
+    load: () => import("./plugins/guides/store-secrets/03-step-3-retrieve-the-secret-value.ts"),
+    name: "Store secrets > Step 3: Retrieve the secret value",
+    source: "https://docs.obsidian.md/Plugins/Guides/Store+secrets#Step+3%3A+Retrieve+the+secret+value"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-01",
+    load: () => import("./plugins/releasing/plugin-guidelines/01-use-setheading-instead-of-a-h1-h2.ts"),
+    name: "Plugin guidelines > UI text > Use setHeading instead of a <h1>, <h2>",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Use+%60setHeading%60+instead+of+a+%60%3Ch1%3E%60%2C+%60%3Ch2%3E%60"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-03",
+    load: () => import("./plugins/releasing/plugin-guidelines/03-clean-up-resources-when-plugin-unloads.ts"),
+    name: "Plugin guidelines > Resource management > Clean up resources when plugin unloads",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Clean+up+resources+when+plugin+unloads"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-04",
+    load: () => import("./plugins/releasing/plugin-guidelines/04-avoid-accessing-workspace-activeleaf-dir.ts"),
+    name: "Plugin guidelines > Workspace > Avoid accessing workspace.activeLeaf directly",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+accessing+%60workspace.activeLeaf%60+directly"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-05",
+    load: () => import("./plugins/releasing/plugin-guidelines/05-avoid-accessing-workspace-activeleaf-dir.ts"),
+    name: "Plugin guidelines > Workspace > Avoid accessing workspace.activeLeaf directly (2)",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+accessing+%60workspace.activeLeaf%60+directly"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-10",
+    load: () => import("./plugins/releasing/plugin-guidelines/10-avoid-iterating-all-files-to-find-a-file.ts"),
+    name: "Plugin guidelines > Vault > Avoid iterating all files to find a file by its path (2)",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+iterating+all+files+to+find+a+file+by+its+path"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-11",
+    load: () => import("./plugins/releasing/plugin-guidelines/11-avoid-iterating-all-files-to-find-a-file.ts"),
+    name: "Plugin guidelines > Vault > Avoid iterating all files to find a file by its path (3)",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+iterating+all+files+to+find+a+file+by+its+path"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-13",
+    load: () => import("./plugins/releasing/plugin-guidelines/13-use-normalizepath-to-clean-up-user-defin.ts"),
+    name: "Plugin guidelines > Vault > Use normalizePath() to clean up user-defined paths",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Use+%60normalizePath()%60+to+clean+up+user-defined+paths"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-15",
+    load: () => import("./plugins/releasing/plugin-guidelines/15-no-hardcoded-styling.ts"),
+    name: "Plugin guidelines > Styling > No hardcoded styling",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#No+hardcoded+styling"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-16",
+    load: () => import("./plugins/releasing/plugin-guidelines/16-no-hardcoded-styling.ts"),
+    name: "Plugin guidelines > Styling > No hardcoded styling (2)",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#No+hardcoded+styling"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-17",
+    load: () => import("./plugins/releasing/plugin-guidelines/17-no-hardcoded-styling.ts"),
+    name: "Plugin guidelines > Styling > No hardcoded styling (3)",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#No+hardcoded+styling"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-18",
+    load: () => import("./plugins/releasing/plugin-guidelines/18-prefer-async-await-over-promise.ts"),
+    name: "Plugin guidelines > TypeScript > Prefer async/await over Promise",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Prefer+async%2Fawait+over+Promise"
+  },
+  {
+    id: "plugins-releasing-plugin-guidelines-19",
+    load: () => import("./plugins/releasing/plugin-guidelines/19-prefer-async-await-over-promise.ts"),
+    name: "Plugin guidelines > TypeScript > Prefer async/await over Promise (2)",
+    source: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Prefer+async%2Fawait+over+Promise"
+  },
+  {
+    id: "plugins-user-interface-commands-01",
+    load: () => import("./plugins/user-interface/commands/01-intro.ts"),
+    name: "Commands",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Commands"
+  },
+  {
+    id: "plugins-user-interface-commands-03",
+    load: () => import("./plugins/user-interface/commands/03-editor-commands.ts"),
+    name: "Commands > Editor commands",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Commands#Editor+commands"
+  },
+  {
+    id: "plugins-user-interface-commands-05",
+    load: () => import("./plugins/user-interface/commands/05-hot-keys.ts"),
+    name: "Commands > Hot keys",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Commands#Hot+keys"
+  },
+  {
+    id: "plugins-user-interface-context-menus-01",
+    load: () => import("./plugins/user-interface/context-menus/01-intro.ts"),
+    name: "Context menus",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Context+menus"
+  },
+  {
+    id: "plugins-user-interface-html-elements-02",
+    load: () => import("./plugins/user-interface/html-elements/02-create-html-elements-using-createel.ts"),
+    name: "HTML elements > Create HTML elements using createEl()",
+    source: "https://docs.obsidian.md/Plugins/User+interface/HTML+elements#Create+HTML+elements+using+%60createEl()%60"
+  },
+  {
+    id: "plugins-user-interface-html-elements-03",
+    load: () => import("./plugins/user-interface/html-elements/03-create-html-elements-using-createel.ts"),
+    name: "HTML elements > Create HTML elements using createEl() (2)",
+    source: "https://docs.obsidian.md/Plugins/User+interface/HTML+elements#Create+HTML+elements+using+%60createEl()%60"
+  },
+  {
+    id: "plugins-user-interface-html-elements-04",
+    load: () => import("./plugins/user-interface/html-elements/04-style-your-elements.ts"),
+    name: "HTML elements > Style your elements",
+    source: "https://docs.obsidian.md/Plugins/User+interface/HTML+elements#Style+your+elements"
+  },
+  {
+    id: "plugins-user-interface-html-elements-05",
+    load: () => import("./plugins/user-interface/html-elements/05-style-your-elements.ts"),
+    name: "HTML elements > Style your elements (2)",
+    source: "https://docs.obsidian.md/Plugins/User+interface/HTML+elements#Style+your+elements"
+  },
+  {
+    id: "plugins-user-interface-html-elements-06",
+    load: () => import("./plugins/user-interface/html-elements/06-conditional-styles.ts"),
+    name: "HTML elements > Style your elements > Conditional styles",
+    source: "https://docs.obsidian.md/Plugins/User+interface/HTML+elements#Conditional+styles"
+  },
+  {
+    id: "plugins-user-interface-icons-01",
+    load: () => import("./plugins/user-interface/icons/01-use-icons.ts"),
+    name: "Icons > Use icons",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Icons#Use+icons"
+  },
+  {
+    id: "plugins-user-interface-icons-02",
+    load: () => import("./plugins/user-interface/icons/02-use-icons.ts"),
+    name: "Icons > Use icons (2)",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Icons#Use+icons"
+  },
+  {
+    id: "plugins-user-interface-icons-03",
+    load: () => import("./plugins/user-interface/icons/03-add-your-own-icon.ts"),
+    name: "Icons > Add your own icon",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Icons#Add+your+own+icon"
+  },
+  {
+    id: "plugins-user-interface-modals-01",
+    load: () => import("./plugins/user-interface/modals/01-intro.ts"),
+    name: "Modals",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Modals"
+  },
+  {
+    id: "plugins-user-interface-modals-02",
+    load: () => import("./plugins/user-interface/modals/02-intro.ts"),
+    name: "Modals (2)",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Modals"
+  },
+  {
+    id: "plugins-user-interface-modals-03",
+    load: () => import("./plugins/user-interface/modals/03-accept-user-input.ts"),
+    name: "Modals > Accept user input",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Modals#Accept+user+input"
+  },
+  {
+    id: "plugins-user-interface-modals-04",
+    load: () => import("./plugins/user-interface/modals/04-accept-user-input.ts"),
+    name: "Modals > Accept user input (2)",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Modals#Accept+user+input"
+  },
+  {
+    id: "plugins-user-interface-modals-05",
+    load: () => import("./plugins/user-interface/modals/05-select-from-list-of-suggestions.ts"),
+    name: "Modals > Select from list of suggestions",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Modals#Select+from+list+of+suggestions"
+  },
+  {
+    id: "plugins-user-interface-modals-06",
+    load: () => import("./plugins/user-interface/modals/06-approximate-string-matching-results.ts"),
+    name: "Modals > Select from list of suggestions > Approximate string matching results",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Modals#Approximate+string+matching+results"
+  },
+  {
+    id: "plugins-user-interface-modals-07",
+    load: () => import("./plugins/user-interface/modals/07-custom-rendering-of-fuzzy-search-results.ts"),
+    name: "Modals > Select from list of suggestions > Custom rendering of fuzzy search results",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Modals#Custom+rendering+of+fuzzy+search+results"
+  },
+  {
+    id: "plugins-user-interface-ribbon-actions-01",
+    load: () => import("./plugins/user-interface/ribbon-actions/01-intro.ts"),
+    name: "Ribbon actions",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Ribbon+actions"
+  },
+  {
+    id: "plugins-user-interface-right-to-left-01",
+    load: () => import("./plugins/user-interface/right-to-left/01-use-fallback-values-when-necessary.ts"),
+    name: "Right-to-left > Make plugins and themes agnostic of language direction > Use fallback values when necessary",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Right-to-left#Use+fallback+values+when+necessary"
+  },
+  {
+    id: "plugins-user-interface-right-to-left-02",
+    load: () => import("./plugins/user-interface/right-to-left/02-global-selectors.ts"),
+    name: "Right-to-left > Obsidian CSS helpers and rules for RTL > Selectors for language direction > Global selectors",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Right-to-left#Global+selectors"
+  },
+  {
+    id: "plugins-user-interface-right-to-left-03",
+    load: () => import("./plugins/user-interface/right-to-left/03-icons-are-mirrored-automatically.ts"),
+    name: "Right-to-left > Obsidian CSS helpers and rules for RTL > Icons are mirrored automatically",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Right-to-left#Icons+are+mirrored+automatically"
+  },
+  {
+    id: "plugins-user-interface-settings-09",
+    load: () => import("./plugins/user-interface/settings/09-toggle.ts"),
+    name: "Settings > Control types > Toggle",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Toggle"
+  },
+  {
+    id: "plugins-user-interface-settings-10",
+    load: () => import("./plugins/user-interface/settings/10-text.ts"),
+    name: "Settings > Control types > Text",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Text"
+  },
+  {
+    id: "plugins-user-interface-settings-11",
+    load: () => import("./plugins/user-interface/settings/11-textarea.ts"),
+    name: "Settings > Control types > Textarea",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Textarea"
+  },
+  {
+    id: "plugins-user-interface-settings-12",
+    load: () => import("./plugins/user-interface/settings/12-number.ts"),
+    name: "Settings > Control types > Number",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Number"
+  },
+  {
+    id: "plugins-user-interface-settings-13",
+    load: () => import("./plugins/user-interface/settings/13-slider.ts"),
+    name: "Settings > Control types > Slider",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Slider"
+  },
+  {
+    id: "plugins-user-interface-settings-14",
+    load: () => import("./plugins/user-interface/settings/14-dropdown.ts"),
+    name: "Settings > Control types > Dropdown",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Dropdown"
+  },
+  {
+    id: "plugins-user-interface-settings-15",
+    load: () => import("./plugins/user-interface/settings/15-file.ts"),
+    name: "Settings > Control types > File",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#File"
+  },
+  {
+    id: "plugins-user-interface-settings-16",
+    load: () => import("./plugins/user-interface/settings/16-folder.ts"),
+    name: "Settings > Control types > Folder",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Folder"
+  },
+  {
+    id: "plugins-user-interface-settings-17",
+    load: () => import("./plugins/user-interface/settings/17-color-picker.ts"),
+    name: "Settings > Control types > Color picker",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Color+picker"
+  },
+  {
+    id: "plugins-user-interface-settings-18",
+    load: () => import("./plugins/user-interface/settings/18-validating-input.ts"),
+    name: "Settings > Validating input",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Validating+input"
+  },
+  {
+    id: "plugins-user-interface-settings-23",
+    load: () => import("./plugins/user-interface/settings/23-groups.ts"),
+    name: "Settings > Groups",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Groups"
+  },
+  {
+    id: "plugins-user-interface-settings-32",
+    load: () => import("./plugins/user-interface/settings/32-cleanup.ts"),
+    name: "Settings > Render callback > Cleanup",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Cleanup"
+  },
+  {
+    id: "plugins-user-interface-settings-33",
+    load: () => import("./plugins/user-interface/settings/33-no-top-level-heading.ts"),
+    name: "Settings > Style guide > No top-level heading",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#No+top-level+heading"
+  },
+  {
+    id: "plugins-user-interface-settings-34",
+    load: () => import("./plugins/user-interface/settings/34-headings-only-when-there-are-multiple-se.ts"),
+    name: "Settings > Style guide > Headings only when there are multiple sections",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Headings+only+when+there+are+multiple+sections"
+  },
+  {
+    id: "plugins-user-interface-settings-36",
+    load: () => import("./plugins/user-interface/settings/36-headings.ts"),
+    name: "Settings > Legacy: imperative display() approach > Available components > Headings",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Headings"
+  },
+  {
+    id: "plugins-user-interface-settings-38",
+    load: () => import("./plugins/user-interface/settings/38-moment-format.ts"),
+    name: "Settings > Legacy: imperative display() approach > Available components > Moment format",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Moment+format"
+  },
+  {
+    id: "plugins-user-interface-settings-39",
+    load: () => import("./plugins/user-interface/settings/39-buttons.ts"),
+    name: "Settings > Legacy: imperative display() approach > Available components > Buttons",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Buttons"
+  },
+  {
+    id: "plugins-user-interface-settings-40",
+    load: () => import("./plugins/user-interface/settings/40-extra-button.ts"),
+    name: "Settings > Legacy: imperative display() approach > Available components > Extra button",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Extra+button"
+  },
+  {
+    id: "plugins-user-interface-settings-41",
+    load: () => import("./plugins/user-interface/settings/41-progress-bar.ts"),
+    name: "Settings > Legacy: imperative display() approach > Available components > Progress bar",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Settings#Progress+bar"
+  },
+  {
+    id: "plugins-user-interface-status-bar-01",
+    load: () => import("./plugins/user-interface/status-bar/01-intro.ts"),
+    name: "Status bar",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Status+bar"
+  },
+  {
+    id: "plugins-user-interface-status-bar-02",
+    load: () => import("./plugins/user-interface/status-bar/02-intro.ts"),
+    name: "Status bar (2)",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Status+bar"
+  },
+  {
+    id: "plugins-user-interface-views-01",
+    load: () => import("./plugins/user-interface/views/01-intro.ts"),
+    name: "Views",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Views"
+  },
+  {
+    id: "plugins-user-interface-workspace-05",
+    load: () => import("./plugins/user-interface/workspace/05-inspect-the-workspace.ts"),
+    name: "Workspace > Inspect the workspace",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Workspace#Inspect+the+workspace"
+  },
+  {
+    id: "plugins-user-interface-workspace-06",
+    load: () => import("./plugins/user-interface/workspace/06-leaf-groups.ts"),
+    name: "Workspace > Leaf groups",
+    source: "https://docs.obsidian.md/Plugins/User+interface/Workspace#Leaf+groups"
+  },
+  {
+    id: "plugins-vault-02",
+    load: () => import("./plugins/vault/02-read-files.ts"),
+    name: "Vault > Read files",
+    source: "https://docs.obsidian.md/Plugins/Vault#Read+files"
+  },
+  {
+    id: "plugins-vault-03",
+    load: () => import("./plugins/vault/03-modify-files.ts"),
+    name: "Vault > Modify files",
+    source: "https://docs.obsidian.md/Plugins/Vault#Modify+files"
+  },
+  {
+    id: "plugins-vault-04",
+    load: () => import("./plugins/vault/04-modify-files.ts"),
+    name: "Vault > Modify files (2)",
+    source: "https://docs.obsidian.md/Plugins/Vault#Modify+files"
+  },
+  {
+    id: "plugins-vault-05",
+    load: () => import("./plugins/vault/05-is-it-a-file-or-folder.ts"),
+    name: "Vault > Is it a file or folder?",
+    source: "https://docs.obsidian.md/Plugins/Vault#Is+it+a+file+or+folder%3F"
+  },
+  {
+    id: "reference-css-variables-about-styling-01",
+    load: () => import("./reference/css-variables/about-styling/01-for-plugins.ts"),
+    name: "About styling > For plugins",
+    source: "https://docs.obsidian.md/Reference/CSS+variables/About+styling#For+plugins"
+  },
+  {
+    id: "reference-css-variables-about-styling-02",
+    load: () => import("./reference/css-variables/about-styling/02-for-themes-and-snippets.ts"),
+    name: "About styling > For themes and snippets",
+    source: "https://docs.obsidian.md/Reference/CSS+variables/About+styling#For+themes+and+snippets"
+  },
+  {
+    id: "reference-css-variables-publish-site-fonts-01",
+    load: () => import("./reference/css-variables/publish/site-fonts/01-intro.ts"),
+    name: "Site fonts",
+    source: "https://docs.obsidian.md/Reference/CSS+variables/Publish/Site+fonts"
+  },
+  {
+    id: "reference-typescript-api-command-callback-01",
+    load: () => import("./reference/typescript-api/command/callback/01-example.ts"),
+    name: "callback > Example",
+    source: "https://docs.obsidian.md/Reference/TypeScript+API/Command/callback#Example"
+  },
+  {
+    id: "reference-typescript-api-debounce-01",
+    load: () => import("./reference/typescript-api/debounce/01-example.ts"),
+    name: "debounce > Example",
+    source: "https://docs.obsidian.md/Reference/TypeScript+API/debounce#Example"
+  },
+  {
+    id: "reference-typescript-api-vault-process-01",
+    load: () => import("./reference/typescript-api/vault/process/01-example.ts"),
+    name: "process > Example",
+    source: "https://docs.obsidian.md/Reference/TypeScript+API/Vault/process#Example"
+  },
+  {
+    id: "themes-app-themes-build-a-theme-05",
+    load: () => import("./themes/app-themes/build-a-theme/05-step-4-change-the-font.ts"),
+    name: "Build a theme > Step 4: Change the font (2)",
+    source: "https://docs.obsidian.md/Themes/App+themes/Build+a+theme#Step+4%3A+Change+the+font"
+  },
+  {
+    id: "themes-app-themes-build-a-theme-06",
+    load: () => import("./themes/app-themes/build-a-theme/06-step-5-change-the-background-color.ts"),
+    name: "Build a theme > Step 5: Change the background color",
+    source: "https://docs.obsidian.md/Themes/App+themes/Build+a+theme#Step+5%3A+Change+the+background+color"
+  },
+  {
+    id: "themes-app-themes-build-a-theme-07",
+    load: () => import("./themes/app-themes/build-a-theme/07-step-6-change-the-input-hover-border-col.ts"),
+    name: "Build a theme > Step 6: Change the input hover border color",
+    source: "https://docs.obsidian.md/Themes/App+themes/Build+a+theme#Step+6%3A+Change+the+input+hover+border+color"
+  },
+  {
+    id: "themes-app-themes-build-a-theme-08",
+    load: () => import("./themes/app-themes/build-a-theme/08-step-7-discover-css-variables-in-use.ts"),
+    name: "Build a theme > Step 7: Discover CSS variables in use",
+    source: "https://docs.obsidian.md/Themes/App+themes/Build+a+theme#Step+7%3A+Discover+CSS+variables+in+use"
+  },
+  {
+    id: "themes-app-themes-embed-fonts-and-images-in-your-theme-02",
+    load: () => import("./themes/app-themes/embed-fonts-and-images-in-your-theme/02-use-data-urls.ts"),
+    name: "Embed fonts and images in your theme > Use data URLs (2)",
+    source: "https://docs.obsidian.md/Themes/App+themes/Embed+fonts+and+images+in+your+theme#Use+data+URLs"
+  },
+  {
+    id: "themes-app-themes-theme-guidelines-01",
+    load: () => import("./themes/app-themes/theme-guidelines/01-use-css-variables.ts"),
+    name: "Theme guidelines > Use CSS variables",
+    source: "https://docs.obsidian.md/Themes/App+themes/Theme+guidelines#Use+CSS+variables"
+  },
+  {
+    id: "themes-obsidian-publish-themes-best-practices-for-publish-themes-01",
+    load: () => import("./themes/obsidian-publish-themes/best-practices-for-publish-themes/01-small-screens-and-mobile-devices.ts"),
+    name: "Best practices for Publish themes > Small screens and mobile devices",
+    source: "https://docs.obsidian.md/Themes/Obsidian+Publish+themes/Best+practices+for+Publish+themes#Small+screens+and+mobile+devices"
+  },
+  {
+    id: "themes-obsidian-publish-themes-build-a-publish-theme-01",
+    load: () => import("./themes/obsidian-publish-themes/build-a-publish-theme/01-intro.ts"),
+    name: "Build a Publish theme",
+    source: "https://docs.obsidian.md/Themes/Obsidian+Publish+themes/Build+a+Publish+theme"
+  }
+];
+
+export function registerDocsShowcase(plugin: Plugin): void {
+  registerDocsEntries(plugin, ENTRIES);
+}