2018-11-27 10:55:52 +00:00
|
|
|
|
|
|
|
![](assets/rustacean.gif)
|
2018-10-31 11:40:46 +00:00
|
|
|
|
2018-11-27 03:34:35 +00:00
|
|
|
# Rust Search Extension
|
|
|
|
|
2020-02-24 09:01:04 +00:00
|
|
|
### The ultimate search extension for Rust
|
|
|
|
|
2018-11-29 15:56:40 +00:00
|
|
|
![Chrome Web Store](https://img.shields.io/chrome-web-store/v/ennpfpdlaclocpomkiablnmbppdnlhoh.svg)
|
2019-10-30 03:07:26 +00:00
|
|
|
![Mozilla Add-on](https://img.shields.io/amo/v/rust-search-extension?color=%2320123A)
|
2020-06-04 08:30:32 +00:00
|
|
|
![Microsoft Edge](https://img.shields.io/badge/microsoft--edge-v0.10.0-1D4F8C)
|
2020-08-28 02:18:08 +00:00
|
|
|
[![rust-doc](https://img.shields.io/badge/stable-1.46.0-yellow.svg)](https://doc.rust-lang.org/1.46.0/std/)
|
2020-04-19 13:31:12 +00:00
|
|
|
[![license-mit](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/huhu/rust-search-extension/blob/master/LICENSE-MIT)
|
|
|
|
[![license-apache](https://img.shields.io/badge/license-Apache-yellow.svg)](https://github.com/huhu/rust-search-extension/blob/master/LICENSE-APACHE)
|
2020-05-21 16:40:21 +00:00
|
|
|
[![Discord](https://img.shields.io/discord/711895914494558250?label=chat&logo=discord)](https://discord.com/invite/UAzW4A)
|
2018-11-27 03:34:35 +00:00
|
|
|
|
2020-04-20 06:15:37 +00:00
|
|
|
Search **docs**, **crates**, builtin **attributes**, official **books**, and **error codes**, etc in your address bar instantly.
|
2018-11-27 03:34:35 +00:00
|
|
|
|
2020-08-19 08:16:50 +00:00
|
|
|
[https://rust.extension.sh/](https://rust.extension.sh/)
|
2019-12-03 10:00:53 +00:00
|
|
|
|
2020-05-29 15:32:36 +00:00
|
|
|
## Installation
|
2018-11-29 15:56:40 +00:00
|
|
|
|
2019-10-30 03:07:26 +00:00
|
|
|
- [Chrome Web Store](https://chrome.google.com/webstore/detail/rust-search-extension/ennpfpdlaclocpomkiablnmbppdnlhoh)
|
2018-11-29 15:56:40 +00:00
|
|
|
|
2019-10-30 03:07:26 +00:00
|
|
|
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/rust-search-extension/)
|
2018-11-29 15:56:40 +00:00
|
|
|
|
2020-04-15 01:43:42 +00:00
|
|
|
- [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/olemfibpaicdoooacpfffccidjjagmoe)
|
|
|
|
|
2020-05-29 15:32:36 +00:00
|
|
|
## Features
|
2018-11-27 03:34:35 +00:00
|
|
|
|
|
|
|
- Search Primitive Types and Modules
|
|
|
|
- Search Structs, Traits and Enums
|
|
|
|
- Search Functions, Methods and Macros
|
2020-02-03 08:39:59 +00:00
|
|
|
- Search builtin attributes
|
2020-06-04 08:30:32 +00:00
|
|
|
- Search crates on https://crates.io or https://lib.rs
|
2020-04-20 06:15:37 +00:00
|
|
|
- Search crate's docs on docs.rs
|
2020-05-29 15:32:36 +00:00
|
|
|
- Search [Compiler Error Index](https://doc.rust-lang.org/error-index.html) with error codes
|
2020-02-24 09:01:04 +00:00
|
|
|
- Search Rust official book chapters
|
2020-04-20 06:15:37 +00:00
|
|
|
- Search Cargo Clippy lints
|
2020-08-28 02:18:08 +00:00
|
|
|
- Search nightly docs
|
2020-03-28 10:14:41 +00:00
|
|
|
- Offline mode, search local Rust docs (`rustup docs --std`)
|
2020-08-25 09:58:36 +00:00
|
|
|
- Builtin commands (`:yet`, `:book`, `:stable`, `:book`, `:label`, `:tool`, `:mirror` and `:history` etc)
|
2020-06-04 08:30:32 +00:00
|
|
|
- Docs.rs enhancements (display Feature flags)
|
2018-11-27 03:34:35 +00:00
|
|
|
|
2020-05-29 15:32:36 +00:00
|
|
|
## How to use it
|
2018-11-27 03:34:35 +00:00
|
|
|
|
2020-03-10 15:59:25 +00:00
|
|
|
Input keyword **rs** in the address bar, press `Space` to activate the search bar. Then enter any word
|
2018-11-27 10:55:52 +00:00
|
|
|
you want to search, the extension will response the related search results instantly.
|
2018-11-27 03:34:35 +00:00
|
|
|
|
|
|
|
![demonstration.gif](assets/demonstration.gif)
|
|
|
|
|
2020-06-09 14:28:01 +00:00
|
|
|
## Diagram
|
|
|
|
|
|
|
|
![diagram](assets/diagram.jpg)
|
|
|
|
|
2020-05-29 15:32:36 +00:00
|
|
|
## Contribution
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ git clone --recursive https://github.com/huhu/rust-search-extension
|
|
|
|
Cloning into 'rust-search-extension'...
|
|
|
|
$ cd rust-search-extension
|
|
|
|
|
2020-06-05 03:19:56 +00:00
|
|
|
$ make chrome # For Chrome version
|
2020-05-29 15:32:36 +00:00
|
|
|
|
|
|
|
$ make firefox # For Firefox version
|
2020-06-05 03:19:56 +00:00
|
|
|
|
|
|
|
$ make edge # For Edge version
|
2020-05-29 15:32:36 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Get involved
|
2020-05-21 16:40:21 +00:00
|
|
|
|
|
|
|
- You can contact us on Discord Channel: https://discord.com/invite/UAzW4A
|
|
|
|
- Or by adding the Wechat ID: `huhu_io`, we'll invite you to our Wechat group.
|
|
|
|
|
2020-05-29 15:32:36 +00:00
|
|
|
|
|
|
|
## Miscellaneous
|
2020-05-21 16:40:21 +00:00
|
|
|
|
2020-08-19 08:16:50 +00:00
|
|
|
- [Changelog](https://rust.extension.sh/changelog/)
|
|
|
|
- [FAQ](https://rust.extension.sh/faq/)
|
2020-05-27 14:03:04 +00:00
|
|
|
|
2020-05-29 15:32:36 +00:00
|
|
|
## Thanks
|
2020-05-27 14:03:04 +00:00
|
|
|
|
|
|
|
Thanks for the sponsorship from these great companies.
|
|
|
|
|
2020-05-29 15:32:36 +00:00
|
|
|
[![](docs/static/jetbrains.svg)](https://www.jetbrains.com/?from=rust-search-extension)
|
|
|
|
|
|
|
|
[![](docs/static/vercel.svg)](https://vercel.com?utm_source=rust-search-extension)
|