Skip to content

Commit 1cf9d45

Browse files
committed
Updated documentation
1 parent 871f693 commit 1cf9d45

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+2407
-735
lines changed

docs/blog/.authors.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
squidfunk:
2+
name: Martin Donath
3+
description: Creator
4+
avatar: https://avatars.githubusercontent.com/u/932156

docs/blog/.meta.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
comments: true
2+
hide:
3+
- feedback

docs/blog/index.md

+2-144
Original file line numberDiff line numberDiff line change
@@ -1,146 +1,4 @@
1-
---
2-
template: overrides/main.html
3-
title: Blog
4-
search:
5-
exclude: true
6-
---
7-
8-
<style>
9-
.md-sidebar--secondary:not([hidden]) {
10-
visibility: hidden;
11-
}
12-
</style>
13-
141
# Blog
152

16-
## [Chinese search support – 中文搜索​支持]
17-
18-
__Insiders adds experimental Chinese language support for the [built-in search
19-
plugin] – a feature that has been requested for a long time given the large
20-
number of Chinese users.__
21-
22-
<aside class="mdx-author" markdown>
23-
![@squidfunk][@squidfunk avatar]
24-
25-
<span>__Martin Donath__ · @squidfunk</span>
26-
<span>
27-
:octicons-calendar-24: May 5, 2022 ·
28-
:octicons-clock-24: 5 min read ·
29-
[:octicons-tag-24: 8.2.13+insiders-4.14.0][insiders-4.14.0]
30-
</span>
31-
</aside>
32-
33-
---
34-
35-
After the United States and Germany, the third-largest country of origin of
36-
Material for MkDocs users is China. For a long time, the [built-in search plugin]
37-
didn't allow for proper segmentation of Chinese characters, mainly due to
38-
missing support in [`lunr-languages`][lunr-languages] which is used for search
39-
tokenization and stemming. The latest Insiders release adds long-awaited Chinese
40-
language support for the built-in search plugin, something that has been
41-
requested by many users.
42-
43-
[:octicons-arrow-right-24: Continue reading][Chinese search support – 中文搜索​支持]
44-
45-
[built-in search plugin]: ../setup/setting-up-site-search.md#built-in-search-plugin
46-
[@squidfunk avatar]: https://avatars.githubusercontent.com/u/932156
47-
[insiders-4.14.0]: ../insiders/changelog.md#4.14.0
48-
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
49-
[Chinese search support – 中文搜索​支持]: 2022/chinese-search-support.md
50-
51-
## [The past, present and future]
52-
53-
__2021 was a fantastic year for this project as we shipped many new awesome
54-
features, saw significant user growth and leveraged GitHub Sponsors to make the
55-
project sustainable.__
56-
57-
<aside class="mdx-author" markdown>
58-
![@squidfunk][@squidfunk avatar]
59-
60-
<span>__Martin Donath__ · @squidfunk</span>
61-
<span>
62-
:octicons-calendar-24: December 27, 2021 ·
63-
:octicons-clock-24: 10 min read
64-
</span>
65-
</aside>
66-
67-
---
68-
69-
Today, together, MkDocs and Material for MkDocs are among the most popular
70-
options when it comes to choosing a static site generator and theme for your
71-
technical documentation project. Material for MkDocs ensures that your
72-
content is always perfectly presented to your audience, regardless of screen
73-
resolution or device capabilities. It has evolved to a framework for technical
74-
writing, offering many features, some of which are yet to be found in other
75-
static site generators. However, we're far from the end, as 2022 is going to
76-
bring some interesting new capabilities.
77-
78-
[:octicons-arrow-right-24: Continue reading][The past, present and future]
79-
80-
[The past, present and future]: 2021/the-past-present-and-future.md
81-
82-
## [Excluding content from search]
83-
84-
__The latest Insiders release brings three new simple ways to exclude dedicated
85-
parts of a document from the search index, allowing for more fine-grained
86-
control.__
87-
88-
<aside class="mdx-author" markdown>
89-
![@squidfunk][@squidfunk avatar]
90-
91-
<span>__Martin Donath__ · @squidfunk</span>
92-
<span>
93-
:octicons-calendar-24: September 26, 2021 ·
94-
:octicons-clock-24: 5 min read ·
95-
[:octicons-tag-24: 7.3.0+insiders-3.1.1][insiders-3.1.1]
96-
</span>
97-
</aside>
98-
99-
---
100-
101-
Two weeks ago, Material for MkDocs Insiders shipped a brand new search plugin,
102-
yielding massive improvements in usability, but also in speed and size of the
103-
search index. Interestingly, as discussed in the previous blog article, we only
104-
scratched the surface of what's now possible. This release brings some useful
105-
features that enhance the writing experience, allowing for more fine-grained
106-
control of what pages, sections and blocks of a Markdown file should be indexed
107-
by the built-in search functionality.
108-
109-
[:octicons-arrow-right-24: Continue reading][Excluding content from search]
110-
111-
[Excluding content from search]: 2021/excluding-content-from-search.md
112-
[insiders-3.1.1]: ../insiders/changelog.md#3.1.1
113-
114-
## [Search: better, faster, smaller]
115-
116-
__This is the story of how we managed to completely rebuild client-side search,
117-
delivering a significantly better user experience while making it faster and
118-
smaller at the same time.__
119-
120-
<aside class="mdx-author" markdown>
121-
![@squidfunk][@squidfunk avatar]
122-
123-
<span>__Martin Donath__ · @squidfunk</span>
124-
<span>
125-
:octicons-calendar-24: September 13, 2021 ·
126-
:octicons-clock-24: 15 min read ·
127-
[:octicons-tag-24: 7.2.6+insiders-3.0.0][insiders-3.0.0]
128-
</span>
129-
</aside>
130-
131-
---
132-
133-
The search of Material for MkDocs is by far one of its best and most-loved
134-
assets: multilingual, offline-capable, and most importantly: _all client-side_.
135-
It provides a solution to empower the users of your documentation to find what
136-
they're searching for instantly without the headache of managing additional
137-
servers. However, even though several iterations have been made, there's still
138-
some room for improvement, which is why we rebuilt the search plugin and
139-
integration from the ground up. This article shines some light on the internals
140-
of the new search, why it's much more powerful than the previous version, and
141-
what's about to come.
142-
143-
[:octicons-arrow-right-24: Continue reading][Search: better, faster, smaller]
144-
145-
[Search: better, faster, smaller]: 2021/search-better-faster-smaller.md
146-
[insiders-3.0.0]: ../insiders/changelog.md#3.0.0
3+
This is our blog where we write about new features, performance improvements
4+
and the project in general.

0 commit comments

Comments
 (0)