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 (latest)
     1. Clone this repository, including its submodules.
     2. Install npm.
     3. Run npm install in the root directory.
     4. Run npm run obsidian:install <vault directory> in the root directory.
   • Obsidian42 - BRAT (latest)
     • See their readme.
2. Enable plugin.
3. (optional) Configure plugin settings.

Usage

• PLACEHOLDER

Contributing

Contributions are welcome!

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))

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
latest	✅
outdated	❌

Reporting a vulnerability

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