@docusaurus/plugin-content-docs/src/types.ts

Docs plugin for Docusaurus.

/**
 * 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.
 */

import type {TagMetadata} from '@docusaurus/utils';
import type {
  LoadedVersion,
  CategoryGeneratedIndexMetadata,
} from '@docusaurus/plugin-content-docs';
import type {SidebarsUtils} from './sidebars/utils';

export type DocFile = {
  contentPath: string; // /!\ may be localized
  filePath: string; // /!\ may be localized
  source: string;
  content: string;
};

export type VersionTag = TagMetadata & {
  /** All doc ids having this tag. */
  docIds: string[];
  unlisted: boolean;
};
export type VersionTags = {
  [permalink: string]: VersionTag;
};

export type FullVersion = LoadedVersion & {
  sidebarsUtils: SidebarsUtils;
  categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
};