Skip to content

Commit 9be30b4

Browse files
committed
Improved language in blog entry
1 parent ef1d2ff commit 9be30b4

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

docs/blog/2021/search-better-faster-smaller.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -584,20 +584,22 @@ reach:
584584
| __Material for MkDocs__ | | | |
585585
| Index size | 573 kB | __335 kB__ | __–42%__ |
586586
| Index size (`gzip`) | 105 kB | __78 kB__ | __–27%__ |
587-
| Indexing time^‡^ | 265 ms | __177 ms__ | __–34%__ |
588-
| __KJV Markdown[^7]__ | | | |
587+
| Indexing time[^7] | 265 ms | __177 ms__ | __–34%__ |
588+
| __KJV Markdown[^8]__ | | | |
589589
| Index size | 8.2 MB | __4.4 MB__ | __–47%__ |
590590
| Index size (`gzip`) | 2.3 MB | __1.2 MB__ | __–48%__ |
591-
| Indexing time^‡^ | 2,700 ms | __1,390 ms__ | __–48%__ |
591+
| Indexing time | 2,700 ms | __1,390 ms__ | __–48%__ |
592592
593593
<figcaption>
594594
<p>Benchmark results</p>
595-
<small>‡ Smallest value of ten distinct runs</small>
596595
</figcaption>
597596
598597
</figure>
599598
600599
[^7]:
600+
Smallest value of ten distinct runs.
601+
602+
[^8]:
601603
We agnostically use [KJV Markdown][39] as a tool for testing to learn how
602604
Material for MkDocs behaves on large corpora, as it's a very large set of
603605
Markdown files with over 800k words.
@@ -608,7 +610,7 @@ new search is up to 95% faster__. This is a significant improvement,
608610
particularly relevant for large documentation projects.
609611
610612
While 1,3s still may sound like a long time, using the new client-side search
611-
together with [instant loading][40] only initializes the search on the initial
613+
together with [instant loading][40] only creates the search index on the initial
612614
page load. When navigating, the search index is preserved across pages, so the
613615
cost does only have to be paid once.
614616
@@ -617,8 +619,8 @@ cost does only have to be paid once.
617619
618620
### User interface
619621
620-
Additionally, some small improvements have been made, most prominently the __#
621-
more results on this page__ button, which now sticks to the top of the search
622+
Additionally, some small improvements have been made, most prominently the
623+
__more results on this page__ button, which now sticks to the top of the search
622624
result list when open. This enables the user to jump out of the list more
623625
quickly.
624626
@@ -640,7 +642,8 @@ better. Next up:
640642
641643
If you've made it this far, thank you for your time and interest in Material
642644
for MkDocs! This is the first blog article that I decided to write after a
643-
short [Twitter survey][41] made me to. Feel free to leave a comment when you
644-
have something to say.
645+
short [Twitter survey][41] made me to. You're invited to [leave a comment][42]
646+
to share your experiences with the new search implementation.
645647
646648
[41]: https://twitter.com/squidfunk/status/1434477478823743488
649+
[42]: #__comments

0 commit comments

Comments
 (0)