PLACEHOLDER for Obsidian

To apply this Obsidian plugin template, replace all occurrences of PLACEHOLDER and obsidian-plugin-template.

PLACEHOLDER

Repository · Changelog · Community plugin · Features · Installation · Usage · Contributing · Security

For first time users, read the installation section first!

This file is automatically opened on first install. You can reopen it in settings or command palette.

Features

• PLACEHOLDER

Installation

1. Install plugin.
   • Community plugins
     1. Install the plugin from community plugins directly.
   • Manual
     1. Create directory PLACEHOLDER under .obsidian/plugins of your vault.
     2. Place manifest.json, main.js, and styles.css from the latest release into the directory.
   • Building (rolling)
     1. Clone this repository, including its submodules.
     2. Install bun. See https://bun.sh for installation.
     3. Run bun install in the root directory.
     4. Run bun run obsidian:install <vault directory> in the root directory.
   • Obsidian42 - BRAT (rolling)
     • See their readme.
2. Enable plugin.
3. (optional) Configure plugin settings.

Usage

• PLACEHOLDER

Contributing

Contributions are welcome!

Changesets

This project uses changesets to manage the changelog. When creating a pull request, please add a changeset describing the changes. Add multiple changesets if your pull request changes several things. End each changeset with ([PR number](PR link) by [author username](author link)). For example, the newly created file under the directory .changeset should look like:

---
"example": patch
---

This is an example change. ([GH#1](https://github.com/ghost/example/pull/1) by [@ghost](https://github.com/ghost))

Linting, Commit, and Hooks

This project uses the following tools to ensure code and commit quality:

• ESLint: Linting for TypeScript/JavaScript. Run with bun run check (lint only) or bun run fix (auto-fix lint issues).
• Prettier: Code formatting. Run with bun run format (format all files) or bun run format:check (check formatting only).
• markdownlint: Lints Markdown files. Run with bun run markdownlint or auto-fix with bun run markdownlint:fix.
• commitlint: Enforces conventional commit messages. Used automatically on commit via Husky.
• husky: Manages Git hooks. Pre-commit runs lint-staged and pre-push runs commitlint.
• lint-staged: Runs linters on staged files. Markdown files are auto-fixed before commit.

Lint-staged note: The lint-staged configuration (.lintstagedrc.mjs) invokes formatter/linter binaries directly (for example prettier --write, eslint --cache --fix, markdownlint-cli2 --fix) so that the list of staged files is passed through to the tool. Invoking these via bun run would prevent lint-staged from forwarding filenames and cause the tool to operate on its default glob (or the entire repo). Use bun run format to format the entire repository when needed.

To set up locally:

1. Run bun install to install dependencies and set up hooks.
2. On commit, staged Markdown files will be linted and auto-fixed.
3. Commit messages are checked for conventional format.

You can manually run:

• bun run check — lint all code (no formatting)
• bun run fix — auto-fix lint issues (no formatting)
• bun run format — format all code with Prettier
• bun run format:check — check formatting with Prettier
• bun run markdownlint — check all Markdown files
• bun run markdownlint:fix — auto-fix Markdown files
• bun run commitlint — check commit messages in range

Configuration files:

• .eslintrc.* or eslint.config.mjs — ESLint rules
• .prettierrc — Prettier rules
• .prettierignore — Prettier ignore patterns
• .markdownlint.jsonc — markdownlint rules
• .commitlintrc.js — commitlint config
• .husky/ — Git hooks

Testing

This repository uses Vitest for fast unit tests. Tests live under tests/ and should be named *.spec.ts or *.spec.js.

• Run locally (non-interactive, coverage): bun run test (runs vitest run --coverage).
• Run locally (interactive / watch): bun run test:watch.
• Git hooks: The pre-push hook runs bun run test (see .husky/pre-push) and will block pushes if tests fail.

See vitest.config.mts for minimal config and further instructions.

Todos

The todos here, ordered alphabetically, are things planned for the plugin. There are no guarantees that they will be completed. However, we are likely to accept contributions for them.

• PLACEHOLDER

Translating

See assets/locales/README.md.

Security

We hope that there will never be any security vulnerabilities, but unfortunately it does happen. Please report them!

Supported versions

Version	Supported
rolling	✅
latest	✅
outdated	❌

Reporting a vulnerability

Please report a vulnerability by opening an new issue. We will get back to you as soon as possible.