@docusaurus/plugin-content-docs 0.0.0-4593 → 0.0.0-4597

package/lib/index.js

@@ -133,7 +133,7 @@ async function pluginContentDocs(context, options) {
         },
         async contentLoaded({ content, actions }) {
             const { loadedVersions } = content;
-            const { docLayoutComponent, docItemComponent, docCategoryGeneratedIndexComponent, } = options;
+            const { docLayoutComponent, docItemComponent, docCategoryGeneratedIndexComponent, breadcrumbs, } = options;
             const { addRoute, createData, setGlobalData } = actions;
             async function createVersionTagsRoutes(version) {
                 const versionTags = (0, tags_1.getVersionTags)(version.docs);
@@ -191,6 +191,7 @@ async function pluginContentDocs(context, options) {
             setGlobalData({
                 path: (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath]),
                 versions: loadedVersions.map(globalData_1.toGlobalDataVersion),
+                breadcrumbs,
             });
         },
         configureWebpack(_config, isServer, utils, content) {

package/lib/options.js

@@ -42,6 +42,7 @@ exports.DEFAULT_OPTIONS = {
     editLocalizedFiles: false,
     sidebarCollapsible: true,
     sidebarCollapsed: true,
+    breadcrumbs: true,
 };
 const VersionOptionsSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().allow('').optional(),
@@ -98,6 +99,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
     disableVersioning: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.disableVersioning),
     lastVersion: utils_validation_1.Joi.string().optional(),
     versions: VersionsOptionsSchema,
+    breadcrumbs: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.breadcrumbs),
 });
 function validateOptions({ validate, options: userOptions, }) {
     let options = userOptions;

package/lib/sidebars/types.d.ts

@@ -121,6 +121,7 @@ export declare type PropSidebar = PropSidebarItem[];
 export declare type PropSidebars = {
     [sidebarId: string]: PropSidebar;
 };
+export declare type PropSidebarBreadcrumbsItem = PropSidebarItemLink | PropSidebarItemCategory;
 export declare type PropVersionDoc = {
     id: string;
     title: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4593",
+  "version": "0.0.0-4597",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4593",
-    "@docusaurus/logger": "0.0.0-4593",
-    "@docusaurus/mdx-loader": "0.0.0-4593",
-    "@docusaurus/utils": "0.0.0-4593",
-    "@docusaurus/utils-validation": "0.0.0-4593",
+    "@docusaurus/core": "0.0.0-4597",
+    "@docusaurus/logger": "0.0.0-4597",
+    "@docusaurus/mdx-loader": "0.0.0-4597",
+    "@docusaurus/utils": "0.0.0-4597",
+    "@docusaurus/utils-validation": "0.0.0-4597",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.3.0",
@@ -39,8 +39,8 @@
     "webpack": "^5.68.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4593",
-    "@docusaurus/types": "0.0.0-4593",
+    "@docusaurus/module-type-aliases": "0.0.0-4597",
+    "@docusaurus/types": "0.0.0-4597",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "fc32eabcb5fb2b1f75d1582d2ea5aa7a0679f241"
+  "gitHead": "635ab60e7cf821111d46dee45baf932c5bf8220f"
 }

package/src/index.ts

@@ -217,6 +217,7 @@ export default async function pluginContentDocs(
         docLayoutComponent,
         docItemComponent,
         docCategoryGeneratedIndexComponent,
+        breadcrumbs,
       } = options;
       const {addRoute, createData, setGlobalData} = actions;
 
@@ -295,6 +296,7 @@ export default async function pluginContentDocs(
       setGlobalData<GlobalPluginData>({
         path: normalizeUrl([baseUrl, options.routeBasePath]),
         versions: loadedVersions.map(toGlobalDataVersion),
+        breadcrumbs,
       });
     },
 

package/src/options.ts

@@ -55,6 +55,7 @@ export const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'> = {
   editLocalizedFiles: false,
   sidebarCollapsible: true,
   sidebarCollapsed: true,
+  breadcrumbs: true,
 };
 
 const VersionOptionsSchema = Joi.object({
@@ -139,6 +140,7 @@ export const OptionsSchema = Joi.object({
   disableVersioning: Joi.bool().default(DEFAULT_OPTIONS.disableVersioning),
   lastVersion: Joi.string().optional(),
   versions: VersionsOptionsSchema,
+  breadcrumbs: Joi.bool().default(DEFAULT_OPTIONS.breadcrumbs),
 });
 
 export function validateOptions({

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

@@ -38,6 +38,7 @@ declare module '@docusaurus/plugin-content-docs' {
     showLastUpdateTime?: boolean;
     showLastUpdateAuthor?: boolean;
     numberPrefixParser: NumberPrefixParser;
+    breadcrumbs: boolean;
   };
 
   export type PathOptions = {
@@ -126,6 +127,8 @@ declare module '@docusaurus/plugin-content-docs' {
   export type PropSidebarItemCategory =
     import('./sidebars/types').PropSidebarItemCategory;
   export type PropSidebarItem = import('./sidebars/types').PropSidebarItem;
+  export type PropSidebarBreadcrumbsItem =
+    import('./sidebars/types').PropSidebarBreadcrumbsItem;
   export type PropSidebar = import('./sidebars/types').PropSidebar;
   export type PropSidebars = import('./sidebars/types').PropSidebars;
 
@@ -237,6 +240,10 @@ declare module '@theme/DocTagDocListPage' {
   export default function DocTagDocListPage(props: Props): JSX.Element;
 }
 
+declare module '@theme/DocBreadcrumbs' {
+  export default function DocBreadcrumbs(): JSX.Element;
+}
+
 declare module '@theme/DocPage' {
   import type {PropVersionMetadata} from '@docusaurus/plugin-content-docs';
   import type {DocumentRoute} from '@theme/DocItem';
@@ -294,6 +301,7 @@ declare module '@docusaurus/plugin-content-docs/client' {
   export type GlobalPluginData = {
     path: string;
     versions: GlobalVersion[];
+    breadcrumbs: boolean;
   };
   export type DocVersionSuggestions = {
     // suggest the latest version

package/src/sidebars/types.ts

@@ -195,6 +195,10 @@ export type PropSidebars = {
   [sidebarId: string]: PropSidebar;
 };
 
+export type PropSidebarBreadcrumbsItem =
+  | PropSidebarItemLink
+  | PropSidebarItemCategory;
+
 export type PropVersionDoc = {
   id: string;
   title: string;