{"repo":"rochacbruno/doc_lsp","free":true,"listed":false,"github":"https://github.com/rochacbruno/doc_lsp","clone":"git clone https://github.com/rochacbruno/doc_lsp.git","description":"Document variables in a separate md text file and this LSP will show the docs on your editor.","language":"Python","stars":14,"topics":["configuration","documentation","language-server-protocol","lsp","lsp-server","markdown","settings","vim-lsp","vscode-extension","vscode-lsp"],"license":"AGPL-3.0","category":"dev-tools","readme_excerpt":"doc-lsp doc-lsp is a simple specification and LSP (Language Server) that loads comments from a separate file. Document variables in a separate markdown file and this LSP will show the docs on your editor. Works on: - Python - YAML - JSON - TOML - INI - Properties - Conf - .env files - and more... Standard Assuming a file named settings.py Or a config.conf Then the LSP will lookup information about each variable on a separate file. settings.py.md config.conf.md Usage With the LSP Server doc-lsp enabled on your editor, having the variable selected or with cursor focus, trigger the action view doc and the editor will show the overlay with the full text from the respective comment file. = mouse cursor position Hovering the mouse over the variable will show the documentation. If the settings.py.md does not exist, then the action will be NOOP and just emit a INFO Doc not found for variable . Installation Install the Language Server Editor Integration VS Code Extension The easiest way to use doc-lsp in VS Code is with the official extension: 1. Build and install the extension : 2. Configure (optional): See code/doc-lsp-vscode/README.md for detailed instructions. Generic LSP Proxy (Alternative for VS Code) You can also use the Generic LSP Proxy extension: 1. Install the extension 2. Create .vscode/lsp-proxy.json in your workspace (see example in .vscode/lsp-proxy.json ) 3. Reload VS Code Other Editors doc-lsp implements the Language Server Protocol and can be used with any LSP-compat","default_branch":null,"files":null,"tree":[],"storefront":"/r/rochacbruno","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/rochacbruno/doc_lsp/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}