# obsidian-various-complements-plugin

[![release](https://img.shields.io/github/release/tadashi-aikawa/obsidian-various-complements-plugin.svg)](https://github.com/tadashi-aikawa/obsidian-various-complements-plugin/releases/latest)
[![Tests](https://github.com/tadashi-aikawa/obsidian-various-complements-plugin/workflows/Tests/badge.svg)](https://github.com/tadashi-aikawa/obsidian-various-complements-plugin/actions)
![downloads](https://img.shields.io/github/downloads/tadashi-aikawa/obsidian-various-complements-plugin/total)

This plugin for [Obsidian] enables you complete words like the auto-completion of IDE.

![](https://tadashi-aikawa.github.io/docs-obsidian-various-complements-plugin/resources/various-complements.gif)

## 📚 Documentation

- [Official](https://tadashi-aikawa.github.io/docs-obsidian-various-complements-plugin/)
- [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tadashi-aikawa/obsidian-various-complements-plugin)

## 👥 For users

### Feature requests / Bugs

Please create a new [issue].

### Questions / Others

Please create a new [discussion].

### Pull requests

Before creating a pull request, please make an [issue] or a [discussion]😉

[issue]: https://github.com/tadashi-aikawa/obsidian-various-complements-plugin/issues
[discussion]: https://github.com/tadashi-aikawa/obsidian-various-complements-plugin/discussions

## 🖥️ For developers

- Requirements
    - Node.js v24
    - [Betterleaks](https://github.com/betterleaks)

### Development

#### Set up

```bash
git config core.hooksPath hooks
```

#### Install dependencies

```bash
pnpm ci
```

#### Build for development

```bash
pnpm dev
```

#### Test

```bash
pnpm test
# or
pnpm test --watch
```

#### CI

```bash
pnpm verify
```

#### Release

Run [Release Action](https://github.com/tadashi-aikawa/obsidian-various-complements-plugin/actions/workflows/release.yaml).

[Obsidian]: https://obsidian.md/