mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
146 lines
5.2 KiB
TypeScript
146 lines
5.2 KiB
TypeScript
/*
|
|
* Copyright (c) 2016-2022 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.
|
|
*/
|
|
|
|
import { getElement, getLocation } from "~/browser"
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Types
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Feature flag
|
|
*/
|
|
export type Flag =
|
|
| "content.code.annotate" /* Code annotations */
|
|
| "content.tabs.link" /* Link content tabs */
|
|
| "header.autohide" /* Hide header */
|
|
| "navigation.expand" /* Automatic expansion */
|
|
| "navigation.indexes" /* Section pages */
|
|
| "navigation.instant" /* Instant loading */
|
|
| "navigation.sections" /* Section navigation */
|
|
| "navigation.tabs" /* Tabs navigation */
|
|
| "navigation.tabs.sticky" /* Tabs navigation (sticky) */
|
|
| "navigation.top" /* Back-to-top button */
|
|
| "navigation.tracking" /* Anchor tracking */
|
|
| "search.highlight" /* Search highlighting */
|
|
| "search.share" /* Search sharing */
|
|
| "search.suggest" /* Search suggestions */
|
|
| "toc.integrate" /* Integrated table of contents */
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Translation
|
|
*/
|
|
export type Translation =
|
|
| "clipboard.copy" /* Copy to clipboard */
|
|
| "clipboard.copied" /* Copied to clipboard */
|
|
| "search.config.lang" /* Search language */
|
|
| "search.config.pipeline" /* Search pipeline */
|
|
| "search.config.separator" /* Search separator */
|
|
| "search.placeholder" /* Search */
|
|
| "search.result.placeholder" /* Type to start searching */
|
|
| "search.result.none" /* No matching documents */
|
|
| "search.result.one" /* 1 matching document */
|
|
| "search.result.other" /* # matching documents */
|
|
| "search.result.more.one" /* 1 more on this page */
|
|
| "search.result.more.other" /* # more on this page */
|
|
| "search.result.term.missing" /* Missing */
|
|
| "select.version.title" /* Version selector */
|
|
|
|
/**
|
|
* Translations
|
|
*/
|
|
export type Translations = Record<Translation, string>
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Versioning
|
|
*/
|
|
export interface Versioning {
|
|
provider: "mike" /* Version provider */
|
|
default?: string /* Default version */
|
|
}
|
|
|
|
/**
|
|
* Configuration
|
|
*/
|
|
export interface Config {
|
|
base: string /* Base URL */
|
|
features: Flag[] /* Feature flags */
|
|
translations: Translations /* Translations */
|
|
search: string /* Search worker URL */
|
|
version?: Versioning /* Versioning */
|
|
}
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Data
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Retrieve global configuration and make base URL absolute
|
|
*/
|
|
const script = getElement("#__config")
|
|
const config: Config = JSON.parse(script.textContent!)
|
|
config.base = `${new URL(config.base, getLocation())}`
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Functions
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Retrieve global configuration
|
|
*
|
|
* @returns Global configuration
|
|
*/
|
|
export function configuration(): Config {
|
|
return config
|
|
}
|
|
|
|
/**
|
|
* Check whether a feature flag is enabled
|
|
*
|
|
* @param flag - Feature flag
|
|
*
|
|
* @returns Test result
|
|
*/
|
|
export function feature(flag: Flag): boolean {
|
|
return config.features.includes(flag)
|
|
}
|
|
|
|
/**
|
|
* Retrieve the translation for the given key
|
|
*
|
|
* @param key - Key to be translated
|
|
* @param value - Positional value, if any
|
|
*
|
|
* @returns Translation
|
|
*/
|
|
export function translation(
|
|
key: Translation, value?: string | number
|
|
): string {
|
|
return typeof value !== "undefined"
|
|
? config.translations[key].replace("#", value.toString())
|
|
: config.translations[key]
|
|
}
|