Plugin Library for Obsidian

Library for Obsidian plugins.

Repository · Changelog · Other things · Installation · Contributing · Security

Installation

This is NOT an installable plugin.

Usage

This library depends on moment and i18next, which Obsidian already bundles. When building your plugin, remap this import to Obsidian's global to avoid bundling duplicates. With esbuild (the default for Obsidian plugins):

import { esbuildPluginGlobals } from "esbuild-plugin-globals";

// In your esbuild config:
plugins: [
  esbuildPluginGlobals({
    i18next: "i18next",
    moment: "moment",
  }),
]

For other build tools, set up equivalent aliases to the global moment and i18next object provided by Obsidian.

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.

• (None)

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 a private vulnerability report. We will get back to you as soon as possible.