https://github.com/pticalin/vault_image-description
Ollama powered image description
https://github.com/pticalin/vault_image-description
ai-generated-descriptions image-captioning image-captioning-ai image-captioning-annotation-tool image-to-text local-ai multimodal obsidian-plugin obsidian-tools ollama
Last synced: 3 months ago
JSON representation
Ollama powered image description
- Host: GitHub
- URL: https://github.com/pticalin/vault_image-description
- Owner: PtiCalin
- License: mit
- Created: 2025-06-05T22:09:41.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-06-18T00:29:09.000Z (4 months ago)
- Last Synced: 2025-06-18T01:27:32.623Z (4 months ago)
- Topics: ai-generated-descriptions, image-captioning, image-captioning-ai, image-captioning-annotation-tool, image-to-text, local-ai, multimodal, obsidian-plugin, obsidian-tools, ollama
- Language: JavaScript
- Homepage:
- Size: 64.5 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: change-log.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 🔌 VaultOS Plugin Template | Obsidian
> _A modular beginning to powerful plugin architecture — designed the PtiCalin way._
Welcome to the VaultOS-style Obsidian Plugin Template — structured, scalable, and friendly to creators.
Built to streamline development, boost creativity, and follow best practices recommended by the Obsidian community.
[](LICENSE)
[]()
[](./.github/PULL_REQUEST_TEMPLATE.md)
[](https://github.com/sponsors/pticalin)
---
## 🧰 Features
- 🧠 TypeScript-based Obsidian plugin scaffold
- 🎯 100% compatible with [Obsidian sample plugin structure](https://github.com/obsidianmd/obsidian-sample-plugin)
- ⚙️ Rollup-powered build system
- ✨ Includes GitHub workflows, issue templates, and PR templates
- 📦 Clean modular layout for faster scaling
- 💬 Optional Discussions and Sponsor links
---
## 🚀 Getting Started
Clone the repo and install dependencies:
```bash
git clone https://github.com/your-username/temp-repo-obsidian-plugin.git
cd temp-repo-obsidian-plugin
npm install
npm run build
```
Then copy the `dist/` folder into `.obsidian/plugins/your-plugin-id/` in your Obsidian vault.
---
## 🛠 Dev Mode (Live Compile)
Use live watch mode to iterate quickly:
```bash
npm run dev
```
Make changes to `src/main.ts` (or other `.ts` files), and they'll recompile on save.
---
## 🧱 Folder Structure
```bash
📦 temp-repo-obsidian-plugin/
├── .github/ → Issues, PR templates, workflows
├── dist/ → Final build (used by Obsidian)
├── src/ → TypeScript source files
├── main.ts → Entry point (if not using src/)
├── styles.css → Optional plugin styles
├── manifest.json → Plugin metadata
├── package.json → Build scripts & dependencies
├── rollup.config.js → Bundler setup
├── tsconfig.json → TypeScript config
└── README.md → You're here!
```
---
## 🔄 Releasing a New Version
To publish a new release:
1. Update `manifest.json` and `versions.json`
2. Run:
```bash
npm version patch | minor | major
```
3. Create a new GitHub release:
- Tag must match the version (e.g., `1.0.1`, not `v1.0.1`)
- Attach `main.js`, `manifest.json`, and `styles.css`
See [sample-plugin releases](https://github.com/obsidianmd/obsidian-sample-plugin/releases) for reference.
---
## 🌐 Adding Your Plugin to Obsidian's Community List
1. Ensure your repo has:
- `manifest.json`
- `main.js`
- `README.md`
2. Follow the [official plugin submission guide](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines)
3. Submit a PR to [`obsidian-releases`](https://github.com/obsidianmd/obsidian-releases)
---
## 🤝 Contributing
We love PRs, discussions, and feedback!
- [🐛 Report a Bug](https://github.com/your-username/temp-repo-obsidian-plugin/issues/new?template=bug.yml)
- [🌟 Request a Feature](https://github.com/your-username/temp-repo-obsidian-plugin/issues/new?template=feature-request.yml)
- [📦 Open a PR](./.github/PULL_REQUEST_TEMPLATE.md)
See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.
---
## 📜 License
MIT — open for remixing, improving, and learning from.
Please credit and consider sharing back improvements.
---
## 💌 Sponsor
If this template helped you get started faster or with more clarity,
consider supporting PtiCalin's ongoing plugin ecosystem and modular tooling work:
➡ [github.com/sponsors/pticalin](https://github.com/sponsors/pticalin)
---
> _Have fun building. Spend less time structuring and more time imagining._