2018-11-27 10:55:52 +00:00
2018-10-31 11:40:46 +00:00
2018-11-27 03:34:35 +00:00
# Rust Search Extension
2020-10-22 06:29:26 +00:00
[简体中文 ](README-ZH.md )
2020-10-22 06:27:21 +00:00
2020-09-07 11:38:08 +00:00
### The ultimate search extension for Rust
2020-02-24 09:01:04 +00:00
2020-12-12 17:35:17 +00:00
[](https://chrome.google.com/webstore/detail/rust-search-extension/ennpfpdlaclocpomkiablnmbppdnlhoh)
[](https://addons.mozilla.org/firefox/addon/rust-search-extension/)
2024-02-14 07:38:51 +00:00
[](https://microsoftedge.microsoft.com/addons/detail/olemfibpaicdoooacpfffccidjjagmoe)
2020-04-19 13:31:12 +00:00
[](https://github.com/huhu/rust-search-extension/blob/master/LICENSE-MIT)
[](https://github.com/huhu/rust-search-extension/blob/master/LICENSE-APACHE)
2020-10-13 01:19:55 +00:00
[](https://discord.gg/xucZNVd)
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
2021-03-21 04:19:23 +00:00
- Search nightly and rustc docs
2020-06-04 08:30:32 +00:00
- Search crates on https://crates.io or https://lib.rs
2020-10-23 10:04:22 +00:00
- Search any third-party crate's docs
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-10-23 10:04:22 +00:00
- Search [Caniuse.rs ](https://caniuse.rs ) and RFC
- Offline mode supported, search local Rust docs (`rustup docs --std`)
2020-12-14 12:02:23 +00:00
- Builtin commands (`:yet`, `:book` , `:stable` , `:label` , `:tool` , `:mirror` , `:update` and `:history` etc)
2021-07-25 10:01:57 +00:00
- Docs.rs enhancements (display Feature flags, show table of content)
2020-12-23 15:27:46 +00:00
- Github rust-lang release page enhancements (show table of content)
2021-01-05 14:58:27 +00:00
- docs.rust-lang.org enhancements (link all "since" and "issue" label)
2021-07-25 10:01:57 +00:00
- Support import/export your local data
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
2020-05-29 15:32:36 +00:00
## Contribution
2020-12-23 15:27:46 +00:00
[jsonnet ](https://jsonnet.org/ ) is required before getting started. To install `jsonnet` ,
please check `jsonnet` 's [README ](https://github.com/google/jsonnet#packages ).
For Linux users, the `snap` is a good choice to [install jsonnet ](https://snapcraft.io/install/jsonnet/ubuntu ).
2020-05-29 15:32:36 +00:00
```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
2021-05-13 16:43:54 +00:00
You can contact us on Discord Channel: https://discord.gg/xucZNVd
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.
2023-03-26 04:20:50 +00:00
[](https://bytebase.com/?from=rust-search-extension)
2020-05-29 15:32:36 +00:00
[](https://vercel.com?utm_source=rust-search-extension)
