Skip to content

Commit

Permalink
Add an Obsidian README documentation for development
Browse files Browse the repository at this point in the history
  • Loading branch information
sabaimran committed Jan 6, 2025
1 parent e89e498 commit eb9aadf
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions src/interface/obsidian/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Obsidian Development

You can use the [Obsidian Khoj plugin](https://obsidian.md/plugins?id=khoj) to share your Obsidian knowledge base with your AI assistant. The plugin will index your notes and make them searchable by your AI assistant.

## Development

In `src/interface/obsidian`, run:

```bash
yarn install
yarn build
```

You'll want to link the built plugin to your Obsidian vault. You can do this by symlinking the built folder to your Obsidian vault's plugins folder. For example:

```bash
ln -s /path/to/khoj-assistant/src/interface/obsidian /path/to/obsidian-vault/.obsidian/plugins/obsidian-assistant
```

Now, once you reload your Obsidian, you should see your updated plugin code running.

0 comments on commit eb9aadf

Please sign in to comment.