obsidian-plugin/shane-lamb_obsidian-llm-docs
1
0
Fork 0
mirror of https://github.com/shane-lamb/obsidian-llm-docs.git synced 2026-07-22 12:30:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
109 commits 2 branches 4 tags 2 MiB
TypeScript 89.4%
CSS 3.7%
JavaScript 3.7%
Shell 3.2%
Find a file
Shane Lamb 9505cf1bfb added selector for default model 
Added a button to choose the default model from a list of available models, in the settings tab. The list is populated from cache.
2025-03-27 23:23:02 +10:00
src added selector for default model 2025-03-27 23:23:02 +10:00
.editorconfig use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
.eslintignore fix .eslintignore (#48) 2023-01-19 10:06:51 -05:00
.eslintrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
.gitignore Update .gitignore (#25) 2022-01-28 10:34:53 -05:00
.npmrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
.prettierrc introduce prettier, reformat files 2025-03-17 23:15:51 +10:00
.tool-versions update node version to 18.15.0 2025-01-15 19:17:01 +10:00
esbuild.config.mjs whole bunch of updates 2025-01-21 19:40:34 +10:00
jest.config.js whole bunch of updates 2025-01-21 19:40:34 +10:00
manifest.json update readme + make changes according to plugin guide 2025-02-15 16:31:49 +10:00
package-lock.json introduce prettier, reformat files 2025-03-17 23:15:51 +10:00
package.json introduce prettier, reformat files 2025-03-17 23:15:51 +10:00
README.md update readme + make changes according to plugin guide 2025-02-15 16:31:49 +10:00
styles.css added selector for default model 2025-03-27 23:23:02 +10:00
tsconfig.json update node version to 18.15.0 2025-01-15 19:17:01 +10:00
version-bump.mjs add version bump script (#10) 2022-01-22 16:13:50 -05:00
versions.json Update for 0.15 2022-08-09 13:38:50 -04:00

README.md

Obsidian LLM docs

This is a plugin for Obsidian (https://obsidian.md) that lets you chat with LLMs in plain markdown files!

Features

  • Use the same Obsidian markdown editor you know and love to chat with LLMs and freely edit conversation history
  • Integrates with the OpenAI API
  • Also works with self-hosted/local LLMs that expose an OpenAI-compatible API, like Ollama (https://ollama.com)
  • Can follow links to other Obsidian documents included in your prompt, making it easier to include additional context

Dev installation

  • Install/use the version of NodeJS specified in the .tool-versions file
  • Run npm i to install dependencies.
  • Run npm run dev to start compilation in watch mode.
  • Reload Obsidian.
  • Enable plugin in settings window.
  • For updates to the Obsidian API run npm update in the command line under your repo folder.

Releasing new releases

  • Update your manifest.json with your new version number, such as 1.0.1, and the minimum Obsidian version required for your latest release.
  • Update your versions.json file with "new-plugin-version": "minimum-obsidian-version" so older versions of Obsidian can download an older version of your plugin that's compatible.
  • Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix v. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
  • Upload the files manifest.json, main.js, styles.css as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
  • Publish the release.

You can simplify the version bump process by running npm version patch, npm version minor or npm version major after updating minAppVersion manually in manifest.json. The command will bump version in manifest.json and package.json, and add the entry for the new version to versions.json

Adding your plugin to the community plugin list