Add an Obsidian README documentation for development

This commit is contained in:
sabaimran
2025-01-05 19:06:27 -08:00
parent e89e49818b
commit eb9aadf72a

View File

@@ -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.