skills.rest
carlos-algms
carlos-algmsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

neovim-documentation

Resolve Neovim help topics by reading local runtime doc files.

2|Updated Jun 1, 2017
Search Tags:#documentation#neovim#local-first#lua api#offline search#help lookup#runtime docs
One-click install
npx skills add https://github.com/carlos-algms/dotfiles --skill neovim-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: neovim-documentation
Source: https://github.com/carlos-algms/dotfiles/tree/main/AI-configs/skills/neovim-documentation
Command: npx skills add https://github.com/carlos-algms/dotfiles --skill neovim-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents hangs and race conditions by ensuring Neovim documentation is loaded safely, letting you quickly answer Neovim help and runtime questions without relying on running headless Neovim.

Core Features & Use Cases

  • Safe local-first doc lookup: Reads Neovim runtime doc files directly from the installed runtime-doc paths (macOS Homebrew, Linux Snap), matching the exact local Neovim version.
  • Fallback discovery and remote retrieval: Derives the runtime/doc location from the nvim binary path when local patterns fail, and only then uses GitHub raw URLs as the least-preferred fallback.
  • Doc-driven question resolution: Supports lookups for help topics, runtime/doc content, and Lua API–related questions by encouraging searching across the runtime doc directory with tools like rg before assuming a file contains the needed information.

Quick Start

Ask for Neovim help on a topic and request the skill to resolve it by reading the appropriate runtime doc files from your local Neovim installation, with online fallback only if local lookup fails.

Frequently Asked Questions about neovim-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I look up Neovim help topics offline without running a headless instance?▼

Neovim documentation lookup resolves help topics by reading local runtime doc files from disk instead of invoking headless nvim. It searches installed documentation across OS-specific paths to provide offline answers safely without hanging.

What is the safest way to search Neovim Lua API documentation locally?▼

Searching Neovim Lua API documentation safely means reading runtime doc files directly from your local installation. This avoids headless nvim race conditions by discovering doc paths and searching content using tools like ripgrep.

Does Neovim documentation lookup work if my runtime files are not in standard Homebrew or Snap paths?▼

Neovim documentation lookup handles non-standard paths by deriving the runtime/doc location directly from the nvim binary path. If local discovery fails, it falls back to retrieving raw documentation files from GitHub.

Why does searching Neovim help cause hangs or race conditions when using headless subprocesses?▼

Headless Neovim subprocesses cause hangs and race conditions during help lookup because they initialize the editor environment unnecessarily. Reading runtime doc files directly from disk prevents these issues by bypassing process invocation entirely.

Can I get accurate Neovim runtime docs matching my exact installed version?▼

You can get accurate Neovim runtime docs matching your exact installed version by reading the local runtime/doc directory. This local-first method ensures the documentation corresponds to your specific Neovim installation rather than a generic source.

Related Skills

Explore More Software Engineering Skills→
papdawinpapdawin

tts-service

Serve Hungarian text-to-speech via FastAPI endpoints with per-tenant voice configuration.

Community
Intermediate
ThePrimeagenThePrimeagen
232

vim

Reference the Neovim Lua API for functions, types, and Vimscript equivalents.

Community
Intermediate
ThePrimeagenThePrimeagen
4.8k

Neovim Diagnostics API Reference

Reference Neovim diagnostic functions and API parameters in Lua.

Community
Intermediate
HybridAIOneHybridAIOne
126

hybridclaw-help

Answer HybridClaw setup, configuration, and command questions from public docs.

Official
Intermediate