Update readme and version

This commit is contained in:
Folyd 2020-06-04 16:30:32 +08:00
parent c3793186c8
commit c729f1bc2f
3 changed files with 26 additions and 9 deletions

View file

@ -7,8 +7,8 @@
![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-v0.9.0-1D4F8C)
[![rust-doc](https://img.shields.io/badge/stable-1.43.0-yellow.svg)](https://doc.rust-lang.org/1.43.0/std/)
![Microsoft Edge](https://img.shields.io/badge/microsoft--edge-v0.10.0-1D4F8C)
[![rust-doc](https://img.shields.io/badge/stable-1.44.0-yellow.svg)](https://doc.rust-lang.org/1.44.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)
[![Discord](https://img.shields.io/discord/711895914494558250?label=chat&logo=discord)](https://discord.com/invite/UAzW4A)
@ -31,14 +31,14 @@ Search **docs**, **crates**, builtin **attributes**, official **books**, and **e
- Search Structs, Traits and Enums
- Search Functions, Methods and Macros
- Search builtin attributes
- Search crates on https://crates.io
- Search crates on https://crates.io or https://lib.rs
- Search crate's docs on docs.rs
- Search [Compiler Error Index](https://doc.rust-lang.org/error-index.html) with error codes
- Search Rust official book chapters
- Search Cargo Clippy lints
- Offline mode, search local Rust docs (`rustup docs --std`)
- Builtin commands (`:yet`, `:book`, `:stable`, `:book`, `:label`, `:tool` and `:history` etc)
- Docs.rs enhancement (display Feature flags)
- Docs.rs enhancements (display Feature flags)
## How to use it

20
docs/README.md Normal file
View file

@ -0,0 +1,20 @@
# Rust Search Extension
The docs and website of Rust Search Extension.
## Get started
1. Install [zola](https://www.getzola.org/)
See zola's [installation documentation](https://www.getzola.org/documentation/getting-started/installation/).
2. Build
```sh
$ cd docs && zola serve
Web server is available at http://127.0.0.1:1111
```
3. Open browser
Open http://127.0.0.1:1111

View file

@ -1,6 +1,5 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<link href="https://fonts.googleapis.com/css?family=Alfa+Slab+One&display=swap" rel="stylesheet">
@ -30,7 +29,6 @@
</style>
<link rel="stylesheet" href="index.css">
</head>
<body>
<div class="toast"></div>
<div class="main">
@ -38,8 +36,8 @@
<img class="logo" src="../icon.png" alt="rust-search-extension">
<h2 class="title">Rust Search Extension</h2>
<div>
<a href="https://doc.rust-lang.org/1.43.0/std/">
<img src="https://img.shields.io/badge/stable-1.43.0-yellow.svg" alt="stable-docs">
<a href="https://doc.rust-lang.org/1.44.0/std/">
<img src="https://img.shields.io/badge/stable-1.44.0-yellow.svg" alt="stable-docs">
</a>
</div>
</div>
@ -77,5 +75,4 @@
<script src="../settings.js"></script>
<script src="toast.js"></script>
<script src="index.js"></script>
</html>