https://github.com/benlubas/neorg-se

a Search Engine for your Neorg notes
https://github.com/benlubas/neorg-se

neorg-module neovim neovim-plugin

Last synced: 27 days ago
JSON representation

a Search Engine for your Neorg notes

• Host: GitHub
• URL: https://github.com/benlubas/neorg-se
• Owner: benlubas
• License: mit
• Created: 2024-07-03T21:36:46.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-27T22:18:47.000Z (4 months ago)
• Last Synced: 2024-08-31T03:02:06.189Z (3 months ago)
• Topics: neorg-module, neovim, neovim-plugin
• Language: Rust
• Homepage:
• Size: 67.4 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neorg - Neorg SE - The power of a search engine for your Neorg workspace. Search notes, titles, categories, and more. (Neorg Modules)

README

        
# neorg-se

> [!WARNING]

> This is a work in progress. Please pin your version and treat updating like installing a new

> plugin until this warning is gone. Thanks!

Search text file content via the [Tantivy](https://github.com/quickwit-oss/tantivy) search engine,

all within Neovim.

---

## Commands

-   `Neorg search index` - Create the search engine index for the current workspace. Must be run each

    time you launch nvim before you can run a query (WIP like I said)

-   `Neorg search query fulltext` - "normal" search. Searches body text, title, and categories

-   `Neorg search query categories` - search for all files tagged with one or more categories

## Install

**You need the rust toolchain installed or this plugin will not build**

  Lazy.nvim

Can be listed as a dependency of `"nvim-neorg/neorg"`

```lua

{ "benlubas/neorg-se" }

```

  Rocks.nvim

`:Rocks install neorg-se`

```lua

["external.search"] = {

    -- values shown are the default

    config = {

        -- Index the workspace when neovim launches. This process happens on a separate thread, so

        -- it doesn't significantly contribute to startup time or block neovim

        index_on_start = true,

    }

},

```

## Integrations

This plugin can also act as a category completion source for

[benlubas/neorg-interim-ls](https://github.com/benlubas/neorg-interim-ls). No additional

configuration is required here. Just install and load this module and configure the rest in

neorg-interim-ls!