Update the release docs for v1.3

This commit is contained in:
Folyd 2021-07-25 18:01:57 +08:00
parent 186b06d865
commit 51f9c2f924
9 changed files with 32 additions and 15 deletions

View file

@ -42,6 +42,7 @@
- Docs.rs 加强,展示每一个 crate 的 Feature flags
- Github release 页面加强(展示所有 Rust 版本目录)
- docs.rust-lang.org 加强(链接所有 "since" 和 "issue" 标签)
- 支持导入、导出本地的数据
## 使用方法
@ -49,10 +50,6 @@
![demonstration.gif](assets/demonstration.gif)
## 图示
![diagram](assets/diagram.jpg)
## 贡献
```bash

View file

@ -41,9 +41,10 @@ Search **docs**, **crates**, builtin **attributes**, official **books**, and **e
- Search [Caniuse.rs](https://caniuse.rs) and RFC
- Offline mode supported, search local Rust docs (`rustup docs --std`)
- Builtin commands (`:yet`, `:book`, `:stable`, `:label`, `:tool`, `:mirror`, `:update` and `:history` etc)
- Docs.rs enhancements (display Feature flags)
- Docs.rs enhancements (display Feature flags, show table of content)
- Github rust-lang release page enhancements (show table of content)
- docs.rust-lang.org enhancements (link all "since" and "issue" label)
- Support import/export your local data
## How to use it
@ -52,10 +53,6 @@ you want to search, the extension will response the related search results insta
![demonstration.gif](assets/demonstration.gif)
## Diagram
![diagram](assets/diagram.jpg)
## Contribution
[jsonnet](https://jsonnet.org/) is required before getting started. To install `jsonnet`,

View file

@ -70,7 +70,7 @@ For example, input `src:try_fold` or `s:try_fold`, you'll open the source code l
## Offline mode: search local Rust docs
You can run command `rustup doc --std` to open the offline std docs.
To enable the offline mode, you should check the checkbox and input the offline docs path on the popup page.
To enable the offline mode, you should check the checkbox and input the offline docs path on the settings page.
However, please check the [Caveats](/faq/#caveats) if you are a Firefox user.
![GIF](/offline-mode.gif)
@ -183,9 +183,13 @@ Docs.rs don't display the crate's feature flags, which is inconvenient. So Rust
By clicking the `+ to Rust Search Extension` button, you can add the crate to the extension, which brings the
search capability for this crate on the address bar.
## Show Table of Content
![IMG](/docs-rs-toc.png)
# Rust repository enhancement
## Show table of content in the release page
## Show Table of Content in the release page
![](/github-release-toc.png)
@ -206,10 +210,18 @@ These charts including:
# Miscellaneous
## Manage your indexed crates
![IMG](/crate-manage.png)
## Import/Export your data
![IMG](/import-export.png)
## Customize crates searching platform
You can customize your preferred crates searching platform such as [crates.io](https://crates.io)(default)
or [lib.rs](https://lib.rs) on the popup page.
or [lib.rs](https://lib.rs) on the settings page.
## Open repository quickly

View file

@ -6,6 +6,17 @@ weight = 3
# v1.3 - Unreleased
- Unify **Settings**, **Statistics** into **manage pages**, additionally, you can also:
- Manage your all indexed crates.
- **Import/Export** your settings, search history, statistics, and crates data.
- Support offline mode in Windows.
- Show **Table of Content** in [docs.rs](https://docs.rs).
- Improvements:
- Only keep the latest 100 search histories.
- Ignore legacy rust std docs, such as [v0.12.0](https://doc.rust-lang.org/0.12.0/std/index.html).
- Bugfix:
- Fix fail to add some crate into the extension issue. Fix {{ issue(id=114) }}, {{ issue(id=119) }}, {{ issue(id=120) }}.
# v1.2 - 2021-03-26
- Support prefix `//` (double slash) to search [rustc crates docs](https://doc.rust-lang.org/nightly/nightly-rustc/). 👉 [Learn more](/#search-rustc-docs).

BIN
docs/static/crate-manage.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

BIN
docs/static/docs-rs-toc.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 132 KiB

BIN
docs/static/import-export.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View file

@ -14,7 +14,7 @@
<h1>Notice</h1>
<p>
If you encounter an auto-opening of this page when you launch your browser,
this is because you have turned on the auto-update configuration in the <span><b>popup page</b></span>.
this is because you have turned on the auto-update configuration in the <span><b>settings page</b></span>.
</p>
<p>
@ -22,7 +22,7 @@
This is mandatory and only necessary for the local index updating.
</p>
<p>You can enable/disable the auto-update in the extension's <span><b>popup page</b></span>.</p>
<p>You can enable/disable the auto-update in the extension's <span><b>settings page</b></span>.</p>
</blockquote>
<div>

View file

@ -48,7 +48,7 @@
<a href="https://rust.extension.sh">Website</a>
</div>
<div class="setting-item">
<a href="https://rust.extension.sh/changlog">Changelog</a>
<a href="https://rust.extension.sh/changelog">Changelog</a>
</div>
<div class="setting-item">
<a href="https://github.com/huhu/rust-search-extension">Github</a>