obsidian-plugin/dsebastien_obsidian-graph-explorer-base-view
1
0
Fork 0
mirror of https://github.com/dsebastien/obsidian-graph-explorer-base-view.git synced 2026-07-22 06:56:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
19 commits 1 branch 12 tags 390 KiB
TypeScript 90.8%
CSS 7.1%
Shell 2%
JavaScript 0.1%
Find a file
Sébastien Dubois 92fabb94df chore(all): set base version
2026-04-07 09:25:16 +02:00
.claude Initial commit 2026-04-07 07:54:24 +02:00
.github Initial commit 2026-04-07 07:54:24 +02:00
.husky Initial commit 2026-04-07 07:54:24 +02:00
docs fix: address code review issues (search highlight, theme reactivity, view option sync, cleanup) 2026-04-07 08:47:40 +02:00
documentation docs: document explored status and graph data business rules 2026-04-07 08:40:26 +02:00
scripts Initial commit 2026-04-07 07:54:24 +02:00
src fix: address code review issues (search highlight, theme reactivity, view option sync, cleanup) 2026-04-07 08:47:40 +02:00
.cz-config.cjs Initial commit 2026-04-07 07:54:24 +02:00
.editorconfig Initial commit 2026-04-07 07:54:24 +02:00
.gitattributes Initial commit 2026-04-07 07:54:24 +02:00
.gitignore Initial commit 2026-04-07 07:54:24 +02:00
.nvmrc Initial commit 2026-04-07 07:54:24 +02:00
.prettierignore Initial commit 2026-04-07 07:54:24 +02:00
AGENTS.md Initial commit 2026-04-07 07:54:24 +02:00
bun.lock fix: address code review issues (search highlight, theme reactivity, view option sync, cleanup) 2026-04-07 08:47:40 +02:00
bunfig.toml Initial commit 2026-04-07 07:54:24 +02:00
CHANGELOG.md Initial commit 2026-04-07 07:54:24 +02:00
CLAUDE.md Initial commit 2026-04-07 07:54:24 +02:00
commitlint.config.ts Initial commit 2026-04-07 07:54:24 +02:00
CONTRIBUTING.md Initial commit 2026-04-07 07:54:24 +02:00
DEVELOPMENT.md Initial commit 2026-04-07 07:54:24 +02:00
eslint.config.ts Initial commit 2026-04-07 07:54:24 +02:00
LICENSE Initial commit 2026-04-07 07:54:24 +02:00
manifest.json chore(all): set base version 2026-04-07 09:25:16 +02:00
package.json chore(all): set base version 2026-04-07 09:25:16 +02:00
prettier.config.cjs Initial commit 2026-04-07 07:54:24 +02:00
README.md Initial commit 2026-04-07 07:54:24 +02:00
TEMPLATE_USAGE.md Initial commit 2026-04-07 07:54:24 +02:00
tsconfig.json Initial commit 2026-04-07 07:54:24 +02:00
versions.json chore(all): set base version 2026-04-07 09:25:16 +02:00

README.md

Obsidian Plugin Template (Bun)

A modern Obsidian plugin template using Bun as the package manager and bundler, with TypeScript, Tailwind CSS v4, ESLint, Prettier, and automated release workflows.

Features

  • Bun for fast package management and bundling
  • TypeScript with strict configuration
  • Tailwind CSS v4 for styling
  • ESLint + Prettier for code quality
  • Husky + lint-staged for pre-commit hooks
  • Commitizen + Conventional Commits for standardized commit messages
  • GitHub Actions for CI/CD and automated releases
  • Immer for immutable state management
  • Zod for runtime validation

Getting Started

See TEMPLATE_USAGE.md for detailed instructions on how to use this template to create your own Obsidian plugin.

Quick Start

  1. Click "Use this template" on GitHub to create a new repository
  2. Clone your new repository
  3. Follow the setup instructions in TEMPLATE_USAGE.md
  4. Run bun install to install dependencies
  5. Run bun run dev to start development

Development

See DEVELOPMENT.md for detailed development instructions.

Prerequisites

  • Bun (latest version)
  • Git
  • An Obsidian vault for testing

Commands

Command Description
bun install Install dependencies
bun run dev Development build with watch mode
bun run build Production build
bun run tsc:watch Type check in watch mode
bun run lint Run ESLint
bun run format Format with Prettier
bun test Run tests

Contributing

See CONTRIBUTING.md for contribution guidelines.

License

MIT License - see LICENSE for details.

News & Support

To stay up to date about this plugin, Obsidian in general, Personal Knowledge Management and note-taking, subscribe to my newsletter. Note that the best way to support my work is to become a paid subscriber ❤️.