refactor(docs/src): delete `material` dir

5 files changed, 0 insertions, 429 deletions

diff --git a/docs/src/templates/assets/javascripts/integrations/search/worker/_/index.ts b/docs/src/templates/assets/javascripts/integrations/search/worker/_/index.ts
deleted file mode 100644
index 26713573..00000000
--- a/docs/src/templates/assets/javascripts/integrations/search/worker/_/index.ts
+++ /dev/null
@@ -1,95 +0,0 @@
-/*
- * Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A RTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import {
-  ObservableInput,
-  Subject,
-  first,
-  merge,
-  of,
-  switchMap
-} from "rxjs"
-
-import { feature } from "~/_"
-import { watchToggle, watchWorker } from "~/browser"
-
-import { SearchIndex } from "../../config"
-import {
-  SearchMessage,
-  SearchMessageType
-} from "../message"
-
-/* ----------------------------------------------------------------------------
- * Functions
- * ------------------------------------------------------------------------- */
-
-/**
- * Set up search worker
- *
- * This function creates and initializes a web worker that is used for search,
- * so that the user interface doesn't freeze. In general, the application does
- * not care how search is implemented, as long as the web worker conforms to
- * the format expected by the application as defined in `SearchMessage`. This
- * allows the author to implement custom search functionality, by providing a
- * custom web worker via configuration.
- *
- * Material for MkDocs' built-in search implementation makes use of Lunr.js, an
- * efficient and fast implementation for client-side search. Leveraging a tiny
- * iframe-based web worker shim, search is even supported for the `file://`
- * protocol, enabling search for local non-hosted builds.
- *
- * If the protocol is `file://`, search initialization is deferred to mitigate
- * freezing, as it's now synchronous by design - see https://bit.ly/3C521EO
- *
- * @see https://bit.ly/3igvtQv - How to implement custom search
- *
- * @param url - Worker URL
- * @param index$ - Search index observable input
- *
- * @returns Search worker
- */
-export function setupSearchWorker(
-  url: string, index$: ObservableInput<SearchIndex>
-): Subject<SearchMessage> {
-  const worker$ = watchWorker<SearchMessage>(url)
-  merge(
-    of(location.protocol !== "file:"),
-    watchToggle("search")
-  )
-    .pipe(
-      first(active => active),
-      switchMap(() => index$)
-    )
-      .subscribe(({ config, docs }) => worker$.next({
-        type: SearchMessageType.SETUP,
-        data: {
-          config,
-          docs,
-          options: {
-            suggest: feature("search.suggest")
-          }
-        }
-      }))
-
-  /* Return search worker */
-  return worker$
-}
diff --git a/docs/src/templates/assets/javascripts/integrations/search/worker/index.ts b/docs/src/templates/assets/javascripts/integrations/search/worker/index.ts
deleted file mode 100644
index 7120ad6e..00000000
--- a/docs/src/templates/assets/javascripts/integrations/search/worker/index.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-/*
- * Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-export * from "./_"
-export * from "./message"
diff --git a/docs/src/templates/assets/javascripts/integrations/search/worker/main/.eslintrc b/docs/src/templates/assets/javascripts/integrations/search/worker/main/.eslintrc
deleted file mode 100644
index 3df9d551..00000000
--- a/docs/src/templates/assets/javascripts/integrations/search/worker/main/.eslintrc
+++ /dev/null
@@ -1,6 +0,0 @@
-{
-  "rules": {
-    "no-console": "off",
-    "@typescript-eslint/no-misused-promises": "off"
-  }
-}
diff --git a/docs/src/templates/assets/javascripts/integrations/search/worker/main/index.ts b/docs/src/templates/assets/javascripts/integrations/search/worker/main/index.ts
deleted file mode 100644
index 2df38080..00000000
--- a/docs/src/templates/assets/javascripts/integrations/search/worker/main/index.ts
+++ /dev/null
@@ -1,192 +0,0 @@
-/*
- * Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A RTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import lunr from "lunr"
-
-import { getElement } from "~/browser/element/_"
-import "~/polyfills"
-
-import { Search } from "../../_"
-import { SearchConfig } from "../../config"
-import {
-  SearchMessage,
-  SearchMessageType
-} from "../message"
-
-/* ----------------------------------------------------------------------------
- * Types
- * ------------------------------------------------------------------------- */
-
-/**
- * Add support for `iframe-worker` shim
- *
- * While `importScripts` is synchronous when executed inside of a web worker,
- * it's not possible to provide a synchronous shim implementation. The cool
- * thing is that awaiting a non-Promise will convert it into a Promise, so
- * extending the type definition to return a `Promise` shouldn't break anything.
- *
- * @see https://bit.ly/2PjDnXi - GitHub comment
- *
- * @param urls - Scripts to load
- *
- * @returns Promise resolving with no result
- */
-declare global {
-  function importScripts(...urls: string[]): Promise<void> | void
-}
-
-/* ----------------------------------------------------------------------------
- * Data
- * ------------------------------------------------------------------------- */
-
-/**
- * Search index
- */
-let index: Search
-
-/* ----------------------------------------------------------------------------
- * Helper functions
- * ------------------------------------------------------------------------- */
-
-/**
- * Fetch (= import) multi-language support through `lunr-languages`
- *
- * This function automatically imports the stemmers necessary to process the
- * languages which are defined as part of the search configuration.
- *
- * If the worker runs inside of an `iframe` (when using `iframe-worker` as
- * a shim), the base URL for the stemmers to be loaded must be determined by
- * searching for the first `script` element with a `src` attribute, which will
- * contain the contents of this script.
- *
- * @param config - Search configuration
- *
- * @returns Promise resolving with no result
- */
-async function setupSearchLanguages(
-  config: SearchConfig
-): Promise<void> {
-  let base = "../lunr"
-
-  /* Detect `iframe-worker` and fix base URL */
-  if (typeof parent !== "undefined" && "IFrameWorker" in parent) {
-    const worker = getElement<HTMLScriptElement>("script[src]")!
-    const [path] = worker.src.split("/worker")
-
-    /* Prefix base with path */
-    base = base.replace("..", path)
-  }
-
-  /* Add scripts for languages */
-  const scripts = []
-  for (const lang of config.lang) {
-    switch (lang) {
-
-      /* Add segmenter for Japanese */
-      case "ja":
-        scripts.push(`${base}/tinyseg.js`)
-        break
-
-      /* Add segmenter for Hindi and Thai */
-      case "hi":
-      case "th":
-        scripts.push(`${base}/wordcut.js`)
-        break
-    }
-
-    /* Add language support */
-    if (lang !== "en")
-      scripts.push(`${base}/min/lunr.${lang}.min.js`)
-  }
-
-  /* Add multi-language support */
-  if (config.lang.length > 1)
-    scripts.push(`${base}/min/lunr.multi.min.js`)
-
-  /* Load scripts synchronously */
-  if (scripts.length)
-    await importScripts(
-      `${base}/min/lunr.stemmer.support.min.js`,
-      ...scripts
-    )
-}
-
-/* ----------------------------------------------------------------------------
- * Functions
- * ------------------------------------------------------------------------- */
-
-/**
- * Message handler
- *
- * @param message - Source message
- *
- * @returns Target message
- */
-export async function handler(
-  message: SearchMessage
-): Promise<SearchMessage> {
-  switch (message.type) {
-
-    /* Search setup message */
-    case SearchMessageType.SETUP:
-      await setupSearchLanguages(message.data.config)
-      index = new Search(message.data)
-      return {
-        type: SearchMessageType.READY
-      }
-
-    /* Search query message */
-    case SearchMessageType.QUERY:
-      const query = message.data
-      try {
-        return {
-          type: SearchMessageType.RESULT,
-          data: index.search(query)
-        }
-
-      /* Return empty result in case of error */
-      } catch (err) {
-        console.warn(`Invalid query: ${query} – see https://bit.ly/2s3ChXG`)
-        console.warn(err)
-        return {
-          type: SearchMessageType.RESULT,
-          data: { items: [] }
-        }
-      }
-
-    /* All other messages */
-    default:
-      throw new TypeError("Invalid message type")
-  }
-}
-
-/* ----------------------------------------------------------------------------
- * Worker
- * ------------------------------------------------------------------------- */
-
-/* Expose Lunr.js in global scope, or stemmers won't work */
-self.lunr = lunr
-
-/* Handle messages */
-addEventListener("message", async ev => {
-  postMessage(await handler(ev.data))
-})
diff --git a/docs/src/templates/assets/javascripts/integrations/search/worker/message/index.ts b/docs/src/templates/assets/javascripts/integrations/search/worker/message/index.ts
deleted file mode 100644
index 54d5001e..00000000
--- a/docs/src/templates/assets/javascripts/integrations/search/worker/message/index.ts
+++ /dev/null
@@ -1,112 +0,0 @@
-/*
- * Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A RTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import { SearchResult } from "../../_"
-import { SearchIndex } from "../../config"
-
-/* ----------------------------------------------------------------------------
- * Types
- * ------------------------------------------------------------------------- */
-
-/**
- * Search message type
- */
-export const enum SearchMessageType {
-  SETUP,                               /* Search index setup */
-  READY,                               /* Search index ready */
-  QUERY,                               /* Search query */
-  RESULT                               /* Search results */
-}
-
-/* ------------------------------------------------------------------------- */
-
-/**
- * Message containing the data necessary to setup the search index
- */
-export interface SearchSetupMessage {
-  type: SearchMessageType.SETUP        /* Message type */
-  data: SearchIndex                    /* Message data */
-}
-
-/**
- * Message indicating the search index is ready
- */
-export interface SearchReadyMessage {
-  type: SearchMessageType.READY        /* Message type */
-}
-
-/**
- * Message containing a search query
- */
-export interface SearchQueryMessage {
-  type: SearchMessageType.QUERY        /* Message type */
-  data: string                         /* Message data */
-}
-
-/**
- * Message containing results for a search query
- */
-export interface SearchResultMessage {
-  type: SearchMessageType.RESULT       /* Message type */
-  data: SearchResult                   /* Message data */
-}
-
-/* ------------------------------------------------------------------------- */
-
-/**
- * Message exchanged with the search worker
- */
-export type SearchMessage =
-  | SearchSetupMessage
-  | SearchReadyMessage
-  | SearchQueryMessage
-  | SearchResultMessage
-
-/* ----------------------------------------------------------------------------
- * Functions
- * ------------------------------------------------------------------------- */
-
-/**
- * Type guard for search ready messages
- *
- * @param message - Search worker message
- *
- * @returns Test result
- */
-export function isSearchReadyMessage(
-  message: SearchMessage
-): message is SearchReadyMessage {
-  return message.type === SearchMessageType.READY
-}
-
-/**
- * Type guard for search result messages
- *
- * @param message - Search worker message
- *
- * @returns Test result
- */
-export function isSearchResultMessage(
-  message: SearchMessage
-): message is SearchResultMessage {
-  return message.type === SearchMessageType.RESULT
-}