@docusaurus/plugin-content-docs
Version:
Docs plugin for Docusaurus.
20 lines (19 loc) • 726 B
TypeScript
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
/** The search tag to append as each doc's metadata. */
export declare function getDocsVersionSearchTag(pluginId: string, versionName: string): string;
/**
* Gets the relevant docs tags to search.
* This is the logic that powers the contextual search feature.
*
* If user is browsing Android 1.4 docs, he'll get presented with:
* - Android '1.4' docs
* - iOS 'preferred | latest' docs
*
* The result is generic and not coupled to Algolia/DocSearch on purpose.
*/
export declare function useDocsContextualSearchTags(): string[];