# Open in GitHub Plugin For Obsidian

This is an Obsidian plugin designed to open projects or files directly in GitHub via your browser. Learn more about Obsidian at https://obsidian.md.

![preview1](./.github/img/preview1.png)
![preview2](./.github/img/preview2.png)

## Installation

1. Download Release Files:
    - main.js
    - manifest.json
2. Copy Files to Plugin Folder:
    Paste the downloaded files into your vault’s plugin folder: `VaultFolder/.obsidian/plugins/open-in-github`
3. Enable the Plugin:
    Restart Obsidian, go to Settings > Community plugins and enable the plugin.

## Development

Clone this repo to `VaultFolder/.obsidian/plugins/` and excute the commands below, then open your Obsidian App.
```
pnpm i
pnpm dev
```

Documentation:
- https://docs.obsidian.md
- https://github.com/obsidianmd/obsidian-api