nuwiki-rs/README.md

nuwiki-rs

The Rust language server (nuwiki-ls) behind nuwiki, the vimwiki-compatible Vim/Neovim plugin.

Note

This repo is the server only. If you just want to use nuwiki in Vim/Neovim, install the plugin from gffranco/nuwiki — it downloads a prebuilt nuwiki-ls binary from this repo's releases automatically, so you don't need this repo or a Rust toolchain. Work here only to develop the parser / LSP / HTML renderer.

Crates

• nuwiki-core — Vimwiki lexer, parser, AST, HTML renderer, and date utilities
• nuwiki-lsp — Language Server Protocol implementation (tower-lsp)
• nuwiki-ls — Binary entry point (stdio server bridge)

Quick Start

# Build
cargo build --release -p nuwiki-ls

# Run
cargo run --bin nuwiki-ls

# Tests
cargo test

License

Licensed under MIT or Apache-2.0, at your option. See LICENSE-MIT and LICENSE-APACHE.