rust-search-extension/README.md
2020-04-19 21:31:12 +08:00

51 lines
No EOL
2.3 KiB
Markdown

![](assets/rustacean.gif)
# Rust Search Extension
### The ultimate search extension for Rust
![Chrome Web Store](https://img.shields.io/chrome-web-store/v/ennpfpdlaclocpomkiablnmbppdnlhoh.svg)
![Mozilla Add-on](https://img.shields.io/amo/v/rust-search-extension?color=%2320123A)
![Microsoft Edge](https://img.shields.io/badge/microsoft--edge-0.8.1-1D4F8C)
[![rust-doc](https://img.shields.io/badge/stable-1.42.0-yellow.svg)](https://doc.rust-lang.org/1.42.0/std/)
[![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)
![Build Status](https://github.com/huhu/rust-search-extension/workflows/build/badge.svg)
Search std **docs**, **crates**, builtin **attributes**, official **books**, and **error codes**, etc in your address bar instantly.
[https://rust-search-extension.now.sh/](https://rust-search-extension.now.sh/)
### Installation
- [Chrome Web Store](https://chrome.google.com/webstore/detail/rust-search-extension/ennpfpdlaclocpomkiablnmbppdnlhoh)
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/rust-search-extension/)
- [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/olemfibpaicdoooacpfffccidjjagmoe)
### Features
- Search Primitive Types and Modules
- Search Structs, Traits and Enums
- Search Functions, Methods and Macros
- Search builtin attributes
- Search crates on https://crates.io
- Search [Compiler Error Index](https://doc.rust-lang.org/error-index.html) with error code
- Search Rust official book chapters
- Offline mode, search local Rust docs (`rustup docs --std`)
- Builtin commands (`:yet`, `:book`, `:stable`, `:book` and `:history` etc)
- Docs.rs enhancement (display Feature flags)
### How to use it
Input keyword **rs** in the address bar, press `Space` to activate the search bar. Then enter any word
you want to search, the extension will response the related search results instantly.
![demonstration.gif](assets/demonstration.gif)
# [Features overview](https://rust-search-extension.now.sh/)
# [How it works](https://rust-search-extension.now.sh/how-it-works/)
# [Changelog](https://rust-search-extension.now.sh/changelog/)
# [FAQ](https://rust-search-extension.now.sh/faq/)