Skip to main content

Installation

💡TL;DR

Install Notemd from Obsidian Community plugins, or copy the three plugin files from the same GitHub Release into your Vault. Enable it, configure a provider, and run a disposable test note. Model servers and optional native exporters have separate prerequisites.

  1. Open Settings → Community plugins in the intended Vault.
  2. Enable community plugins if required, then choose Browse.
  3. Search for Notemd, check the repository is Jacobinwwey/obsidian-NotEMD, and select Install.
  4. Select Enable. Open the Notemd sidebar with its ribbon icon or the command palette.

Open Notemd in Obsidian. If your browser cannot open that link, use the manual steps above; no custom protocol handler is needed to read this guide.

Method 2: Manual Installation​

Prerequisites​

Use an installed Obsidian application and a Vault you can back up. The manifest declares a minimum Obsidian version of 0.15.0; that declaration is not evidence that the latest candidate was tested on that old version.

Steps​

  1. Open GitHub Releases and download main.js, manifest.json and styles.css from the same release. The release also includes README.md for reference; it is not a runtime installation requirement.
  2. Create <vault>/.obsidian/plugins/notemd/ and copy the three plugin files there. .obsidian is the default configuration directory; use your Vault's configured directory if it differs.
  3. Reload Obsidian, open Community plugins, and enable Notemd.
  4. Check the displayed plugin version before proceeding to provider setup. Do not mix a new manifest with an old bundle.

Alternative: Install via BRAT​

If you already use BRAT, add Jacobinwwey/obsidian-NotEMD through its beta-plugin workflow. Use an explicit release when reproducing a bug. BRAT is an optional external tool, not a dependency of the normal installation.

Verification​

Open Notemd settings, choose an accessible provider/model and run Test connection. Then follow the quick start with a copied note. Some connection tests only establish that a model-list endpoint is reachable; a real task verifies generation and output handling.

System Requirements​

SurfaceBoundary
Plugin manifestMinimum Obsidian version declared as 0.15.0; isDesktopOnly is false
Verification evidenceConsult the current release's dated acceptance record; physical mobile devices and Obsidian 0.15.0 are not currently verified
Hosted LLMNetwork access, an authorized account/key and a supported model
Local LLMA separately installed, running server and a downloaded/loaded model
Native slide / circuit exportsDesktop tools and format-specific dependencies; check the export environment before running

There is no blanket OS-version guarantee covering all optional exporters. Previewing a circuit inside Notemd does not prove native TeX compilation, and a desktop test does not establish mobile behavior.

Uninstallation​

Disable or uninstall Notemd from Community plugins. Generated notes and artifacts remain ordinary Vault files; review them before deleting anything. Back up the plugin's settings if you intend to reinstall. Uninstalling the plugin is not a rollback of its completed note edits.

Updating​

Use Check for updates in Community plugins, then update Notemd. For a manual upgrade, stop active Notemd tasks, back up the Vault and settings, replace the three runtime files with files from the same release, and reload. Inspect the release notes and run a small test before resuming batch work.

Do not replace the Vault's settings file with a release asset. To roll back, retain a backup and install a known compatible release deliberately; keep any generated outputs you need.

Next Steps​