Mirrors/rust-search-extension
2
0
Fork 0
mirror of https://github.com/huhu/rust-search-extension synced 2024-11-14 23:57:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Folyd 2018-11-27 20:00:01 +08:00 committed by GitHub
parent db5365cf42
commit b819ad69cb
1 changed files with 28 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -74,8 +74,34 @@ var searchWords = [
]
```
#### 3. Search keyword in *search words array* by *Levenshtein distance*, mapping the *search word* and *search index* to generate the *search result*
#### 3. Search keyword in *search words array*
#### 4. Sort *search result* according to *Levenshtein distance* and others metrics
Using *Levenshtein distance* algorithm to search matched words, the max Levenshtein distance is 2.
```js
// Max levenshtein distance.
var MAX_LEV_DISTANCE = 2;
```
#### 4. Sort *search result*
Sort search result according to *Levenshtein distance*, lexicographical and others metrics.
#### 5. Transform *search result* to *suggestion result* to show in the address bar
Mapping the *search word* and *search index* to generate the *search result*, build Rust doc link for each result item.
```js
var suggestResults = [
{
content: "https://doc.rust-lang.org/std/ops/trait.Deref.html",
description: "std::ops::<match>Deref</match> - <dim>Used for immutable dereferencing operations, like `*v`.</dim>"
},
{
content: "https://doc.rust-lang.org/std/ops/trait.Deref.html#tymethod.deref",
description: "std::ops::Deref::<match>deref</match> - <dim>Dereferences the value.</dim>"
}
...
];
```