diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 115 |
1 files changed, 43 insertions, 72 deletions
@@ -1,90 +1,61 @@ -# Obsidian Sample Plugin +# AI Organizer -This is a sample plugin for Obsidian (https://obsidian.md). +An Obsidian plugin that organizes notes via AI powered by [Ollama](https://ollama.com). -This project uses TypeScript to provide type checking and documentation. -The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does. +## Prerequisites -This sample plugin demonstrates some of the basic functionality the plugin API can do. -- Adds a ribbon icon, which shows a Notice when clicked. -- Adds a command "Open modal (simple)" which opens a Modal. -- Adds a plugin setting tab to the settings page. -- Registers a global click event and output 'click' to the console. -- Registers a global interval which logs 'setInterval' to the console. +- [Obsidian](https://obsidian.md) v0.15.0 or later +- [Ollama](https://ollama.com) installed and running locally (default: `http://localhost:11434`) +- [Node.js](https://nodejs.org) v16 or later (for building from source) -## First time developing plugins? +## Building from Source -Quick starting guide for new plugin devs: - -- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with. -- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). -- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. -- Install NodeJS, then run `npm i` in the command line under your repo folder. -- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. -- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. -- Reload Obsidian to load the new version of your plugin. -- 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 - -- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines). -- Publish an initial version. -- Make sure you have a `README.md` file in the root of your repo. -- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. - -## How to use +```bash +git clone https://github.com/your-repo/aiorganizer_obsidian.git +cd aiorganizer_obsidian +npm install +npm run build +``` -- Clone this repo. -- Make sure your NodeJS is at least v16 (`node --version`). -- `npm i` or `yarn` to install dependencies. -- `npm run dev` to start compilation in watch mode. +For development with auto-rebuild on file changes: -## Manually installing the plugin +```bash +npm run dev +``` -- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. +## Installing the Plugin -## Improve code quality with eslint -- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. -- This project already has eslint preconfigured, you can invoke a check by running`npm run lint` -- Together with a custom eslint [plugin](https://github.com/obsidianmd/eslint-plugin) for Obsidan specific code guidelines. -- A GitHub action is preconfigured to automatically lint every commit on all branches. +### Manual Installation -## Funding URL +1. Build the plugin (see above). +2. Copy `main.js`, `styles.css`, and `manifest.json` into your vault at: + ``` + <VaultFolder>/.obsidian/plugins/ai-organizer/ + ``` +3. Open Obsidian, go to **Settings > Community Plugins**, and enable **AI Organizer**. -You can include funding URLs where people who use your plugin can financially support it. +### Development Installation -The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file: +Clone or symlink this repo directly into your vault's plugin folder for live development: -```json -{ - "fundingUrl": "https://buymeacoffee.com" -} +```bash +cd /path/to/your/vault/.obsidian/plugins +ln -s /path/to/aiorganizer_obsidian ai-organizer ``` -If you have multiple URLs, you can also do: +Then run `npm run dev` and reload Obsidian to pick up changes. -```json -{ - "fundingUrl": { - "Buy Me a Coffee": "https://buymeacoffee.com", - "GitHub Sponsor": "https://github.com/sponsors", - "Patreon": "https://www.patreon.com/" - } -} -``` +## Usage + +1. Click the **message icon** in the left ribbon or run the **"Open AI Chat"** command from the command palette. +2. The chat sidebar opens in the right panel. +3. In the **Settings** section at the bottom of the sidebar: + - Set the **Ollama URL** (defaults to `http://localhost:11434`). + - Click **Test** to verify the connection. + - Select a **Model** from the dropdown. +4. Type a message and press **Enter** to chat with the AI. + - **Shift+Enter** inserts a newline. -## API Documentation +## License -See https://docs.obsidian.md +[0-BSD](LICENSE) |