Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rogercoll/open-browser-rustdoc.vim

vim plugin to open current corresponding rustdoc in a new tab of your default browser
https://github.com/rogercoll/open-browser-rustdoc.vim

rust rust-doc vim-plugin

Last synced: about 1 month ago
JSON representation

vim plugin to open current corresponding rustdoc in a new tab of your default browser

Awesome Lists containing this project

README

        

# open-browser-rustdoc.vim

## About

Opens Rustdoc URL for current crate, standard library, etc. from Vim.

## Install

This plugin requires:

* [open-browser.vim](https://github.com/tyru/open-browser.vim)

Use your favorite plugin manager to install this plugin and all its lua dependencies.

Expand lazy.nvim snippet:

```lua
{
"rogercoll/open-browser-rustdoc.vim",
dependencies = {
"tyru/open-browser.vim", -- Required
},
lazy = false,
}
```

## Usage

There are 2 commands.

### `:OpenRustDocCrate`

Opens a specific crate documentation in docs.rs.

```vimL
" Opens anyhow latest crate's documentation in docs.rs.
:OpenRustDocCrate anyhow
" Opens anyhow version 1.0.0 crate's documentation in docs.rs.
:OpenRustDocCrate anyhow 1.0.0
```

### `:OpenRustDocStd`

Opens Rust standard library in doc.rust-lang.org/std/.

```vimL
:OpenRustDocStd
```

### `:OpenRustDocReleases`

Opens https://releases.rs/docs/.

```vimL
:OpenRustDocReleases
```

## WIP

### `:OpenRustDoc`

Opens the underlying Rust module in docs.rs.

Tracking issue: https://github.com/rogercoll/open-browser-rustdoc.vim/issues/1

## TODO

- [] Open any arbitrary Rust data structure documentation.