https://github.com/lilleaila/obsidian-todo.nvim

https://github.com/lilleaila/obsidian-todo.nvim

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/lilleaila/obsidian-todo.nvim
• Owner: LilleAila
• Created: 2024-09-09T13:23:23.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-13T08:38:25.000Z (3 months ago)
• Last Synced: 2024-09-13T21:04:31.357Z (3 months ago)
• Language: Lua
• Size: 9.77 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# obsidian-todo.nvim

Easily search through your obsidian TODOs items with telescope.

## Usage

Run `:Telescope obsidian_todo obsidian_todo` to open a telescope window with all your TODO-items.

## Installation

### Requirements

- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)

- [ripgrep](https://github.com/BurntSushi/ripgrep)

### Installation

Install the plugin with your favorite plugin manager

#### lazy.nvim

```lua

{ "LilleAila/obsidian-todo.nvim" }

```

### Configuration

Add this to your telescope configuration:

```lua

require("telescope").setup({

    extensions = {

        obsidian_todo = {

            search_path = "$HOME/path/to/your/vault",

            search_pattern = "- [ ] ", -- This is the default value

        },

    },

})

```

## Nixvim

Add this to your inputs:

```nix

inputs.obsidian-todo = {

    url = "github:LilleAila/obsidian-todo.nvim";

    inputs.nixpkgs.follows = "nixpkgs";

}

```

Add this to your configuration:

```nix

extraPlugins = [ inputs.obsidian-todo.packages.${pkgs.system}.default ];

plugins.telescope.settings.extensions.obsidian_todo = {

    search_path = "/path/to/your/vault";

};

extraConfigLua = # lua

  ''

    require("telescope").load_extension("obsidian_todo")

  '';

```