{"id":28509542,"url":"https://github.com/pticalin/temp_repo-obsidian-plugin","last_synced_at":"2025-07-02T23:31:52.756Z","repository":{"id":296477320,"uuid":"993517506","full_name":"PtiCalin/temp_repo-obsidian-plugin","owner":"PtiCalin","description":"This template is the foundation for building modular Obsidian plugins. It includes all necessary config and build files to get started with TypeScript, plus bonus features aligned with VaultOS development, including structured folders for subplugins, compiled logic, and standardized automation patterns.","archived":false,"fork":false,"pushed_at":"2025-06-18T01:35:57.000Z","size":38,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-18T02:26:14.197Z","etag":null,"topics":["boilerplate","developer-tools","obsidian-plugin","plugin-starter","plugin-structure","plugin-template","template-plugin-project","template-repo","template-repository","typescript-template"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PtiCalin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-30T23:51:30.000Z","updated_at":"2025-06-18T01:35:54.000Z","dependencies_parsed_at":"2025-05-31T11:12:52.506Z","dependency_job_id":"cb4925a8-1e40-4730-90ab-7a0e453386c7","html_url":"https://github.com/PtiCalin/temp_repo-obsidian-plugin","commit_stats":null,"previous_names":["pticalin/temp_repo-obsidian-plugin"],"tags_count":3,"template":true,"template_full_name":null,"purl":"pkg:github/PtiCalin/temp_repo-obsidian-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PtiCalin%2Ftemp_repo-obsidian-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PtiCalin%2Ftemp_repo-obsidian-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PtiCalin%2Ftemp_repo-obsidian-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PtiCalin%2Ftemp_repo-obsidian-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PtiCalin","download_url":"https://codeload.github.com/PtiCalin/temp_repo-obsidian-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PtiCalin%2Ftemp_repo-obsidian-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263232701,"owners_count":23434722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","developer-tools","obsidian-plugin","plugin-starter","plugin-structure","plugin-template","template-plugin-project","template-repo","template-repository","typescript-template"],"created_at":"2025-06-08T22:09:01.074Z","updated_at":"2025-07-02T23:31:52.737Z","avatar_url":"https://github.com/PtiCalin.png","language":"TypeScript","funding_links":["https://github.com/sponsors/pticalin"],"categories":[],"sub_categories":[],"readme":"# 🔌 VaultOS Plugin Template | Obsidian\n\n\u003e _A modular beginning to powerful plugin architecture — designed the PtiCalin way._\n\nWelcome to the VaultOS-style Obsidian Plugin Template — structured, scalable, and friendly to creators.  \nBuilt to streamline development, boost creativity, and follow best practices recommended by the Obsidian community.\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)  \n[![Status: In Progress](https://img.shields.io/badge/status-WIP-yellow.svg)]()  \n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./.github/PULL_REQUEST_TEMPLATE.md)  \n[![Sponsor PtiCalin](https://img.shields.io/badge/Sponsor-💖-f06292.svg?logo=githubsponsors)](https://github.com/sponsors/pticalin)\n\n---\n\n## 🧰 Features\n\n- 🧠 TypeScript-based Obsidian plugin scaffold  \n- 🎯 100% compatible with [Obsidian sample plugin structure](https://github.com/obsidianmd/obsidian-sample-plugin)\n- ⚙️ Rollup-powered build system  \n- ✨ Includes GitHub workflows, issue templates, and PR templates  \n- 📦 Clean modular layout for faster scaling  \n- 💬 Optional Discussions and Sponsor links\n\n---\n\n## 🚀 Getting Started\n\nClone the repo and install dependencies:\n\n```bash\ngit clone https://github.com/your-username/temp-repo-obsidian-plugin.git\ncd temp-repo-obsidian-plugin\nnpm install\nnpm run build\n```\n\nThen copy the `dist/` folder into `.obsidian/plugins/your-plugin-id/` in your Obsidian vault.\n\n---\n\n## 🛠 Dev Mode (Live Compile)\n\nUse live watch mode to iterate quickly:\n\n```bash\nnpm run dev\n```\n\nMake changes to `src/main.ts` (or other `.ts` files), and they'll recompile on save.\n\n---\n\n## 🧱 Folder Structure\n\n```bash\n📦 temp-repo-obsidian-plugin/\n├── .github/              → Issues, PR templates, workflows\n├── dist/                 → Final build (used by Obsidian)\n├── src/                  → TypeScript source files\n├── main.ts               → Entry point (if not using src/)\n├── styles.css            → Optional plugin styles\n├── manifest.json         → Plugin metadata\n├── package.json          → Build scripts \u0026 dependencies\n├── rollup.config.js      → Bundler setup\n├── tsconfig.json         → TypeScript config\n└── README.md             → You're here!\n```\n\n---\n\n## 🔄 Releasing a New Version\n\nTo publish a new release:\n\n1. Update `manifest.json` and `versions.json`\n2. Run:\n\n```bash\nnpm version patch | minor | major\n```\n\n3. Create a new GitHub release:\n   - Tag must match the version (e.g., `1.0.1`, not `v1.0.1`)\n   - Attach `main.js`, `manifest.json`, and `styles.css`\n\nSee [sample-plugin releases](https://github.com/obsidianmd/obsidian-sample-plugin/releases) for reference.\n\n---\n\n## 🌐 Adding Your Plugin to Obsidian's Community List\n\n1. Ensure your repo has:\n   - `manifest.json`\n   - `main.js`\n   - `README.md`\n2. Follow the [official plugin submission guide](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines)\n3. Submit a PR to [`obsidian-releases`](https://github.com/obsidianmd/obsidian-releases)\n\n---\n\n## 🤝 Contributing\n\nWe love PRs, discussions, and feedback!\n\n- [🐛 Report a Bug](https://github.com/your-username/temp-repo-obsidian-plugin/issues/new?template=bug.yml)\n- [🌟 Request a Feature](https://github.com/your-username/temp-repo-obsidian-plugin/issues/new?template=feature-request.yml)\n- [📦 Open a PR](./.github/PULL_REQUEST_TEMPLATE.md)\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines.\n\n---\n\n## 📜 License\n\nMIT — open for remixing, improving, and learning from.  \nPlease credit and consider sharing back improvements.\n\n---\n\n## 💌 Sponsor\n\nIf this template helped you get started faster or with more clarity,  \nconsider supporting PtiCalin's ongoing plugin ecosystem and modular tooling work:\n\n➡ [github.com/sponsors/pticalin](https://github.com/sponsors/pticalin)\n\n---\n\n\u003e _Have fun building. Spend less time structuring and more time imagining._  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpticalin%2Ftemp_repo-obsidian-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpticalin%2Ftemp_repo-obsidian-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpticalin%2Ftemp_repo-obsidian-plugin/lists"}