@docusaurus/plugin-content-docs 2.0.1 → 2.1.0

package/lib/options.js

@@ -49,6 +49,7 @@ const VersionOptionsSchema = utils_validation_1.Joi.object({
     banner: utils_validation_1.Joi.string().equal('none', 'unreleased', 'unmaintained').optional(),
     badge: utils_validation_1.Joi.boolean().optional(),
     className: utils_validation_1.Joi.string().optional(),
+    noIndex: utils_validation_1.Joi.boolean().optional(),
 });
 const VersionsOptionsSchema = utils_validation_1.Joi.object()
     .pattern(utils_validation_1.Joi.string().required(), VersionOptionsSchema)

package/lib/props.js

@@ -98,6 +98,7 @@ function toVersionMetadataProp(pluginId, loadedVersion) {
         label: loadedVersion.label,
         banner: loadedVersion.banner,
         badge: loadedVersion.badge,
+        noIndex: loadedVersion.noIndex,
         className: loadedVersion.className,
         isLast: loadedVersion.isLast,
         docsSidebars: toSidebarsProp(loadedVersion),

package/lib/sidebars/types.d.ts

@@ -37,6 +37,7 @@ export declare type SidebarItemLink = SidebarItemBase & {
     type: 'link';
     href: string;
     label: string;
+    autoAddBaseUrl?: boolean;
 };
 export declare type SidebarItemAutogenerated = SidebarItemBase & {
     type: 'autogenerated';

package/lib/sidebars/validation.js

@@ -36,6 +36,7 @@ const sidebarItemHtmlSchema = sidebarItemBaseSchema.append({
 const sidebarItemLinkSchema = sidebarItemBaseSchema.append({
     type: 'link',
     href: utils_validation_1.URISchema.required(),
+    autoAddBaseUrl: utils_validation_1.Joi.boolean(),
     label: utils_validation_1.Joi.string()
         .required()
         .messages({ 'any.unknown': '"label" must be a string' }),

package/lib/versions/index.d.ts

@@ -23,6 +23,7 @@ export declare type VersionContext = {
 export declare function getDefaultVersionBanner({ versionName, versionNames, lastVersionName, }: VersionContext): VersionBanner | null;
 export declare function getVersionBanner(context: VersionContext): VersionMetadata['banner'];
 export declare function getVersionBadge({ versionName, versionNames, options, }: VersionContext): VersionMetadata['badge'];
+export declare function getVersionNoIndex({ versionName, options, }: VersionContext): VersionMetadata['noIndex'];
 /**
  * Filter versions according to provided options (i.e. `onlyIncludeVersions`).
  *

package/lib/versions/index.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readVersionsMetadata = exports.filterVersions = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = void 0;
+exports.readVersionsMetadata = exports.filterVersions = exports.getVersionNoIndex = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
@@ -71,6 +71,10 @@ function getVersionBadge({ versionName, versionNames, options, }) {
     return options.versions[versionName]?.badge ?? defaultVersionBadge;
 }
 exports.getVersionBadge = getVersionBadge;
+function getVersionNoIndex({ versionName, options, }) {
+    return options.versions[versionName]?.noIndex ?? false;
+}
+exports.getVersionNoIndex = getVersionNoIndex;
 function getVersionClassName({ versionName, options, }) {
     const defaultVersionClassName = `docs-version-${versionName}`;
     return options.versions[versionName]?.className ?? defaultVersionClassName;
@@ -108,6 +112,7 @@ async function createVersionMetadata(context) {
         label: getVersionLabel(context),
         banner: getVersionBanner(context),
         badge: getVersionBadge(context),
+        noIndex: getVersionNoIndex(context),
         className: getVersionClassName(context),
         path: routePath,
         tagsPath: (0, utils_1.normalizeUrl)([routePath, options.tagsBasePath]),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -34,13 +34,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.1",
-    "@docusaurus/logger": "2.0.1",
-    "@docusaurus/mdx-loader": "2.0.1",
-    "@docusaurus/module-type-aliases": "2.0.1",
-    "@docusaurus/types": "2.0.1",
-    "@docusaurus/utils": "2.0.1",
-    "@docusaurus/utils-validation": "2.0.1",
+    "@docusaurus/core": "2.1.0",
+    "@docusaurus/logger": "2.1.0",
+    "@docusaurus/mdx-loader": "2.1.0",
+    "@docusaurus/module-type-aliases": "2.1.0",
+    "@docusaurus/types": "2.1.0",
+    "@docusaurus/utils": "2.1.0",
+    "@docusaurus/utils-validation": "2.1.0",
     "@types/react-router-config": "^5.0.6",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.1.0",
@@ -52,7 +52,6 @@
     "webpack": "^5.73.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.21",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -67,5 +66,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "1ddee1c29cabf9bb52e4d78af6ebfaaabb1bc1f9"
+  "gitHead": "be9b0942641184213485eba7fd75ceb0b328d3f4"
 }

package/src/options.ts

@@ -59,6 +59,7 @@ const VersionOptionsSchema = Joi.object({
   banner: Joi.string().equal('none', 'unreleased', 'unmaintained').optional(),
   badge: Joi.boolean().optional(),
   className: Joi.string().optional(),
+  noIndex: Joi.boolean().optional(),
 });
 
 const VersionsOptionsSchema = Joi.object()

package/src/plugin-content-docs.d.ts

@@ -125,6 +125,25 @@ declare module '@docusaurus/plugin-content-docs' {
   // TODO support custom version banner?
   // {type: "error", content: "html content"}
   export type VersionBanner = 'unreleased' | 'unmaintained';
+
+  export type VersionOptions = {
+    /**
+     * The base path of the version, will be appended to `baseUrl` +
+     * `routeBasePath`.
+     */
+    path?: string;
+    /** The label of the version to be used in badges, dropdowns, etc. */
+    label?: string;
+    /** The banner to show at the top of a doc of that version. */
+    banner?: 'none' | VersionBanner;
+    /** Show a badge with the version label at the top of each doc. */
+    badge?: boolean;
+    /** Prevents search engines from indexing this version */
+    noIndex?: boolean;
+    /** Add a custom class name to the <html> element of each doc. */
+    className?: string;
+  };
+
   export type VersionsOptions = {
     /**
      * The version navigated to in priority and displayed by default for docs
@@ -144,23 +163,7 @@ declare module '@docusaurus/plugin-content-docs' {
     /** Include the current version of your docs. */
     includeCurrentVersion: boolean;
     /** Independent customization of each version's properties. */
-    versions: {
-      [versionName: string]: {
-        /**
-         * The base path of the version, will be appended to `baseUrl` +
-         * `routeBasePath`.
-         */
-        path?: string;
-        /** The label of the version to be used in badges, dropdowns, etc. */
-        label?: string;
-        /** The banner to show at the top of a doc of that version. */
-        banner?: 'none' | VersionBanner;
-        /** Show a badge with the version label at the top of each doc. */
-        badge?: boolean;
-        /** Add a custom class name to the <html> element of each doc. */
-        className?: string;
-      };
-    };
+    versions: {[versionName: string]: VersionOptions};
   };
   export type SidebarOptions = {
     /**
@@ -263,6 +266,8 @@ declare module '@docusaurus/plugin-content-docs' {
     banner: VersionBanner | null;
     /** Show a badge with the version label at the top of each doc. */
     badge: boolean;
+    /** Prevents search engines from indexing this version */
+    noIndex: boolean;
     /** Add a custom class name to the <html> element of each doc. */
     className: string;
     /**
@@ -500,7 +505,7 @@ declare module '@docusaurus/plugin-content-docs' {
 
   export type PropVersionMetadata = Pick<
     VersionMetadata,
-    'label' | 'banner' | 'badge' | 'className' | 'isLast'
+    'label' | 'banner' | 'badge' | 'className' | 'isLast' | 'noIndex'
   > & {
     /** ID of the docs plugin this version belongs to. */
     pluginId: string;

package/src/props.ts

@@ -142,6 +142,7 @@ export function toVersionMetadataProp(
     label: loadedVersion.label,
     banner: loadedVersion.banner,
     badge: loadedVersion.badge,
+    noIndex: loadedVersion.noIndex,
     className: loadedVersion.className,
     isLast: loadedVersion.isLast,
     docsSidebars: toSidebarsProp(loadedVersion),

package/src/sidebars/types.ts

@@ -44,6 +44,7 @@ export type SidebarItemLink = SidebarItemBase & {
   type: 'link';
   href: string;
   label: string;
+  autoAddBaseUrl?: boolean;
 };
 
 export type SidebarItemAutogenerated = SidebarItemBase & {

package/src/sidebars/validation.ts

@@ -59,6 +59,7 @@ const sidebarItemHtmlSchema = sidebarItemBaseSchema.append<SidebarItemHtml>({
 const sidebarItemLinkSchema = sidebarItemBaseSchema.append<SidebarItemLink>({
   type: 'link',
   href: URISchema.required(),
+  autoAddBaseUrl: Joi.boolean(),
   label: Joi.string()
     .required()
     .messages({'any.unknown': '"label" must be a string'}),

package/src/versions/index.ts

@@ -122,6 +122,13 @@ export function getVersionBadge({
   return options.versions[versionName]?.badge ?? defaultVersionBadge;
 }
 
+export function getVersionNoIndex({
+  versionName,
+  options,
+}: VersionContext): VersionMetadata['noIndex'] {
+  return options.versions[versionName]?.noIndex ?? false;
+}
+
 function getVersionClassName({
   versionName,
   options,
@@ -179,6 +186,7 @@ async function createVersionMetadata(
     label: getVersionLabel(context),
     banner: getVersionBanner(context),
     badge: getVersionBadge(context),
+    noIndex: getVersionNoIndex(context),
     className: getVersionClassName(context),
     path: routePath,
     tagsPath: normalizeUrl([routePath, options.tagsBasePath]),