CHANGELOG

@@ -1,3 +1,8 @@
+mkdocs-material-5.4.0 (2020-06-29)
+
+  * Added support to wrap searches in quotes to switch from OR to AND
+  * Fixed highlighting of numbers in search results
+
 mkdocs-material-5.3.3 (2020-06-24)
 
   * Added Bengali translations

docs/extensions/pymdown.md

@@ -228,14 +228,14 @@ Example:
 ``` markdown
 * :material-account-circle: – we can use Material Design icons
 * :fontawesome-regular-laugh-wink: – we can also use FontAwesome icons
-* :octicons-octoface: – that's not all, we can also use GitHub's Octicons
+* :octicons-octoface-16: – that's not all, we can also use GitHub's Octicons
 ```
 
 Result:
 
 * :material-account-circle: – we can use [Material Design icons][20]
 * :fontawesome-regular-laugh-wink: – we can also use [FontAwesome icons][21]
-* :octicons-octoface: – that's not all, we can also use [GitHub's Octicons][22]
+* :octicons-octoface-16: – that's not all, we can also use [GitHub's Octicons][22]
 
   [13]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/
   [14]: https://twemoji.twitter.com/

docs/releases/changelog.md

@@ -18,6 +18,11 @@ pip show mkdocs-material
 
 ## Changelog
 
+### 5.4.0 <small>_ June 29, 2020</small>
+
+* Added support to wrap searches in quotes to switch from `OR` to `AND`
+* Fixed highlighting of numbers in search results
+
 ### 5.3.3 <small>_ June 24, 2020</small>
 
 * Added Bengali translations

material/assets/manifest.json

@@ -1,10 +1,10 @@
 {
-  "assets/javascripts/bundle.js": "assets/javascripts/bundle.38f5c9b5.min.js",
-  "assets/javascripts/bundle.js.map": "assets/javascripts/bundle.38f5c9b5.min.js.map",
+  "assets/javascripts/bundle.js": "assets/javascripts/bundle.fc9c3121.min.js",
+  "assets/javascripts/bundle.js.map": "assets/javascripts/bundle.fc9c3121.min.js.map",
   "assets/javascripts/vendor.js": "assets/javascripts/vendor.de50e36d.min.js",
   "assets/javascripts/vendor.js.map": "assets/javascripts/vendor.de50e36d.min.js.map",
-  "assets/javascripts/worker/search.js": "assets/javascripts/worker/search.9b3611bd.min.js",
-  "assets/javascripts/worker/search.js.map": "assets/javascripts/worker/search.9b3611bd.min.js.map",
+  "assets/javascripts/worker/search.js": "assets/javascripts/worker/search.a68abb33.min.js",
+  "assets/javascripts/worker/search.js.map": "assets/javascripts/worker/search.a68abb33.min.js.map",
   "assets/stylesheets/main.css": "assets/stylesheets/main.545621a7.min.css",
   "assets/stylesheets/main.css.map": "assets/stylesheets/main.545621a7.min.css.map",
   "assets/stylesheets/palette.css": "assets/stylesheets/palette.36d1b78f.min.css",

material/base.html

@@ -29,7 +29,7 @@
         <meta name="author" content="{{ config.site_author }}">
       {% endif %}
       <link rel="shortcut icon" href="{{ config.theme.favicon | url }}">
-      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-5.3.3">
+      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-5.4.0">
     {% endblock %}
     {% block htmltitle %}
       {% if page and page.meta and page.meta.title %}
@@ -183,7 +183,7 @@ <h1>{{ page.title | default(config.site_name, true)}}</h1>
     </div>
     {% block scripts %}
       <script src="{{ 'assets/javascripts/vendor.de50e36d.min.js' | url }}"></script>
-      <script src="{{ 'assets/javascripts/bundle.38f5c9b5.min.js' | url }}"></script>
+      <script src="{{ 'assets/javascripts/bundle.fc9c3121.min.js' | url }}"></script>
       {%- set translations = {} -%}
       {%- for key in [
         "clipboard.copy",
@@ -207,7 +207,7 @@ <h1>{{ page.title | default(config.site_name, true)}}</h1>
           base: "{{ base_url }}",
           features: {{ config.theme.features | tojson }},
           search: Object.assign({
-            worker: "{{ 'assets/javascripts/worker/search.9b3611bd.min.js' | url }}"
+            worker: "{{ 'assets/javascripts/worker/search.a68abb33.min.js' | url }}"
           }, typeof search !== "undefined" && search)
         })
       </script>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mkdocs-material",
-  "version": "5.3.3",
+  "version": "5.4.0",
   "description": "A Material Design theme for MkDocs",
   "keywords": [
     "mkdocs",
@@ -50,12 +50,12 @@
     "@types/html-minifier": "^4.0.0",
     "@types/lunr": "^2.3.3",
     "@types/mini-css-extract-plugin": "^0.9.1",
-    "@types/node": "^14.0.13",
+    "@types/node": "^14.0.14",
     "@types/ramda": "^0.27.6",
     "@types/resize-observer-browser": "^0.1.3",
-    "@types/webpack": "^4.41.17",
+    "@types/webpack": "^4.41.18",
     "@types/webpack-assets-manifest": "^3.0.1",
-    "autoprefixer": "9.8.0",
+    "autoprefixer": "9.8.4",
     "copy-webpack-plugin": "^6.0.2",
     "css-loader": "^3.6.0",
     "event-hooks-webpack-plugin": "^2.1.6",
@@ -75,7 +75,7 @@
     "preact": "^10.4.4",
     "resize-observer-polyfill": "^1.5.1",
     "rimraf": "^3.0.2",
-    "sass": "^1.26.8",
+    "sass": "^1.26.9",
     "sass-loader": "^8.0.2",
     "stylelint": "^13.6.1",
     "stylelint-config-rational-order": "^0.1.2",

src/assets/javascripts/integrations/search/highlighter/index.ts

@@ -71,7 +71,7 @@ export function setupSearchHighlighter(
   /* Return factory function */
   return (value: string) => {
     value = value
-      .replace(/[\s*+-:~^]+/g, " ")
+      .replace(/[\s*+\-:~^]+/g, " ")
       .trim()
 
     /* Create search term match expression */

src/assets/javascripts/integrations/search/transform/index.ts

@@ -40,16 +40,38 @@ export type SearchTransformFn = (value: string) => string
 /**
  * Default transformation function
  *
- * Rogue control characters are filtered before handing the query to the
- * search index, as `lunr` will throw otherwise.
+ * 1. Search for terms in quotation marks and prepend a `+` modifier to denote
+ *    that the resulting document must contain all terms, converting the query
+ *    to an `AND` query (as opposed to the default `OR` behavior). While users
+ *    may expect terms enclosed in quotation marks to map to span queries, i.e.
+ *    for which order is important, `lunr` doesn't support them, so the best
+ *    we can do is to convert the terms to an `AND` query.
+ *
+ * 2. Replace control characters which are not located at the beginning of the
+ *    query or preceded by white space, or are not followed by a non-whitespace
+ *    character or are at the end of the query string. Furthermore, filter
+ *    unmatched quotation marks.
+ *
+ * 3. Trim excess whitespace from left and right.
+ *
+ * 4. Append a wildcard to the end of every word to make every word a prefix
+ *    query in order to provide a good type-ahead experience, by adding an
+ *    asterisk (wildcard) in between terms, which can be denoted by whitespace,
+ *    any non-control character, or a word boundary.
  *
  * @param value - Query value
  *
  * @return Transformed query value
  */
 export function defaultTransform(value: string): string {
   return value
-    .replace(/(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g, "")
-    .trim()
-    .replace(/\s+|(?![^\x00-\x7F]|^)$|\b$/g, "* ")
+    .split(/"([^"]+)"/g)                            /* => 1 */
+      .map((terms, i) => i & 1
+        ? terms.replace(/^\b|^(?![^\x00-\x7F]|$)|\s+/g, " +")
+        : terms
+      )
+      .join("")
+    .replace(/"|(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g, "") /* => 2 */
+    .trim()                                         /* => 3 */
+    .replace(/\s+|(?![^\x00-\x7F]|^)$|\b$/g, "* ")  /* => 4 */
 }