madstone-devdocs.nvim

Neovim plugin for offline DevDocs documentation with Telescope integration

A comprehensive Neovim plugin that integrates dedoc for seamless offline access to DevDocs documentation.

✨ Features

• 🔍 Fuzzy Search - Search through 1,000+ DevDocs documentation sets using Telescope
• 🎯 Smart Detection - Automatically detects docset based on current file's filetype
• 📦 Easy Management - Install, update, and remove docsets directly from Neovim
• 🎨 Beautiful UI - Floating windows with syntax highlighting for documentation
• 📚 Offline Access - All documentation available locally, no internet required
• ⌨️ Vim Help - Complete :help madstone-devdocs documentation
• 🚀 Fast - Lazy loading with zero startup cost

📦 Requirements

• Neovim 0.8.0 or later
• dedoc CLI tool (install with: cargo install dedoc)
• telescope.nvim
• plenary.nvim

📥 Installation

lazy.nvim

{
  "madstone-tech/madstone-devdocs",
  dependencies = {
    "nvim-telescope/telescope.nvim",
    "nvim-lua/plenary.nvim",
  },
  cmd = {
    "MadstoneDevdocsFetch",
    "MadstoneDevdocsList",
    "MadstoneDevdocsSearch",
    "MadstoneDevdocsSearchAll",
  },
  keys = {
    { "<leader>sd", desc = "Search DevDocs" },
    { "<leader>dl", desc = "Manage DevDocs" },
  },
  opts = {
    -- Configuration options (see below)
  },
}

🚀 Quick Start

1. Fetch the docset list:

   :MadstoneDevdocsFetch

2. Browse and download docsets:

   :MadstoneDevdocsList

3. Start searching:

   • Place cursor on any keyword
   • Press <leader>sd

📖 Documentation

Full documentation: :help madstone-devdocs

📄 License

MIT License - see LICENSE file for details.

🙏 Credits

• dedoc by toiletbril
• DevDocs
• telescope.nvim

---

Made with ❤️ by Madstone Technology