Skip to content

Commit 2971d2c

Browse files
committed
README
1 parent 5f184f8 commit 2971d2c

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# Library
22

3-
## Searching
3+
This repository serves as a library of community-made resources
4+
(blog posts, videos, presentations, ...). The content is indexed, versioned,
5+
and searchable from [`vale.sh/docs`](https://vale.sh/docs/).
6+
7+
## Submitting a resource
8+
9+
If you'd like to submit your own resource, open a PR that adds it to the `library.json`
10+
file at the root of this repository.
11+
12+
## Searching
13+
14+
We support a query-string syntax powered by [Bleve](https://blevesearch.com/):
15+
16+
- [x] Faceted search: `date:>2021` or `author:jdkato` (`date`, `title`, `author`, `text`, `type`).
17+
- [x] `+foo` (required have)
18+
- [x] `-foo` (required to not have)
19+
- [x] `foo~2` (fuzzy)
20+
- [x] `"foo bar"` (phrase)
21+
- [x] `foo bar` (OR)
22+
23+
See the [Bleve docs](https://blevesearch.com/docs/Query-String-Query/) for more information.

0 commit comments

Comments
 (0)