aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEm Zhan2023-09-13 14:37:39 +0000
committerGitHub2023-09-13 14:37:39 +0000
commitfe6b556f51e5dfac828e139131af99117b655efe (patch)
tree298c9d8505819dd1f7fe23aead6377e31078f51f
parent729f32de21d6ead25c1795f262b1be6661016b46 (diff)
Fix search highlighting for the default docs theme (#8270)
-rw-r--r--book/custom.css2
-rw-r--r--docs/CONTRIBUTING.md13
2 files changed, 11 insertions, 4 deletions
diff --git a/book/custom.css b/book/custom.css
index 0e812090..4b039125 100644
--- a/book/custom.css
+++ b/book/custom.css
@@ -164,7 +164,7 @@ code.hljs {
--searchresults-header-fg: #5f5f71;
--searchresults-border-color: #5c5c68;
--searchresults-li-bg: #242430;
- --search-mark-bg: #acff5;
+ --search-mark-bg: #a2cff5;
}
.colibri .content .header {
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index 982b2237..2be8f77c 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -29,9 +29,15 @@ files, run
cargo xtask docgen
```
-inside the project. We use [xtask][xtask] as an ad-hoc task runner and
-thus do not require any dependencies other than `cargo` (You don't have
-to `cargo install` anything either).
+inside the project. We use [xtask][xtask] as an ad-hoc task runner.
+
+To preview the book itself, install [mdbook][mdbook]. Then, run
+
+```shell
+mdbook serve book
+```
+
+and visit [http://localhost:3000](http://localhost:3000).
# Testing
@@ -58,4 +64,5 @@ The current MSRV and future changes to the MSRV are listed in the [Firefox docum
[architecture.md]: ./architecture.md
[docs]: https://docs.helix-editor.com/
[xtask]: https://github.com/matklad/cargo-xtask
+[mdbook]: https://rust-lang.github.io/mdBook/guide/installation.html
[helpers.rs]: ../helix-term/tests/test/helpers.rs