@docusaurus/plugin-content-docs 2.0.0-beta.8bda3b2db → 2.0.0-beta.9

package/lib/types.d.ts

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { RemarkAndRehypePluginOptions } from '@docusaurus/mdx-loader';
-import { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
+import type { Tag, FrontMatterTag } from '@docusaurus/utils';
+import type { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
+import type { SidebarItemsGeneratorOption, Sidebars } from './sidebars/types';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -18,8 +20,12 @@ export declare type VersionMetadata = ContentPaths & {
     versionName: VersionName;
     versionLabel: string;
     versionPath: string;
+    tagsPath: string;
     versionEditUrl?: string | undefined;
     versionEditUrlLocalized?: string | undefined;
+    versionBanner: VersionBanner | null;
+    versionBadge: boolean;
+    versionClassName: string;
     isLast: boolean;
     sidebarFilePath: string | false | undefined;
     routePriority: number | undefined;
@@ -45,79 +51,36 @@ export declare type PathOptions = {
     path: string;
     sidebarPath?: string | false | undefined;
 };
+export declare type VersionBanner = 'unreleased' | 'unmaintained';
 export declare type VersionOptions = {
     path?: string;
     label?: string;
+    banner?: 'none' | VersionBanner;
+    badge?: boolean;
+    className?: string;
 };
 export declare type VersionsOptions = {
     lastVersion?: string;
     versions: Record<string, VersionOptions>;
     onlyIncludeVersions?: string[];
 };
-export declare type PluginOptions = MetadataOptions & PathOptions & VersionsOptions & RemarkAndRehypePluginOptions & {
+export declare type SidebarOptions = {
+    sidebarCollapsible: boolean;
+    sidebarCollapsed: boolean;
+};
+export declare type PluginOptions = MetadataOptions & PathOptions & VersionsOptions & RemarkAndRehypePluginOptions & SidebarOptions & {
     id: string;
     include: string[];
+    exclude: string[];
     docLayoutComponent: string;
     docItemComponent: string;
+    docTagDocListComponent: string;
+    docTagsListComponent: string;
     admonitions: Record<string, unknown>;
     disableVersioning: boolean;
-    excludeNextVersionDocs?: boolean;
     includeCurrentVersion: boolean;
     sidebarItemsGenerator: SidebarItemsGeneratorOption;
-};
-export declare type SidebarItemBase = {
-    customProps?: Record<string, unknown>;
-};
-export declare type SidebarItemDoc = SidebarItemBase & {
-    type: 'doc' | 'ref';
-    label?: string;
-    id: string;
-};
-export declare type SidebarItemLink = SidebarItemBase & {
-    type: 'link';
-    href: string;
-    label: string;
-};
-export declare type SidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: SidebarItem[];
-    collapsed: boolean;
-};
-export declare type UnprocessedSidebarItemAutogenerated = {
-    type: 'autogenerated';
-    dirName: string;
-};
-export declare type UnprocessedSidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: UnprocessedSidebarItem[];
-    collapsed: boolean;
-};
-export declare type UnprocessedSidebarItem = SidebarItemDoc | SidebarItemLink | UnprocessedSidebarItemCategory | UnprocessedSidebarItemAutogenerated;
-export declare type UnprocessedSidebar = UnprocessedSidebarItem[];
-export declare type UnprocessedSidebars = Record<string, UnprocessedSidebar>;
-export declare type SidebarItem = SidebarItemDoc | SidebarItemLink | SidebarItemCategory;
-export declare type Sidebar = SidebarItem[];
-export declare type SidebarItemType = SidebarItem['type'];
-export declare type Sidebars = Record<string, Sidebar>;
-export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
-export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
-export declare type SidebarItemsGeneratorArgs = {
-    item: UnprocessedSidebarItemAutogenerated;
-    version: SidebarItemsGeneratorVersion;
-    docs: SidebarItemsGeneratorDoc[];
-    numberPrefixParser: NumberPrefixParser;
-};
-export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<SidebarItem[]>;
-export declare type SidebarItemsGeneratorOptionArgs = {
-    defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs;
-export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<SidebarItem[]>;
-export declare type OrderMetadata = {
-    previous?: string;
-    next?: string;
-    sidebar?: string;
+    tagsBasePath: string;
 };
 export declare type LastUpdateData = {
     lastUpdatedAt?: number;
@@ -127,6 +90,7 @@ export declare type LastUpdateData = {
 export declare type DocFrontMatter = {
     id?: string;
     title?: string;
+    tags?: FrontMatterTag[];
     hide_title?: boolean;
     hide_table_of_contents?: boolean;
     keywords?: string[];
@@ -135,9 +99,14 @@ export declare type DocFrontMatter = {
     slug?: string;
     sidebar_label?: string;
     sidebar_position?: number;
+    sidebar_class_name?: string;
     pagination_label?: string;
     custom_edit_url?: string | null;
     parse_number_prefixes?: boolean;
+    toc_min_heading_level?: number;
+    toc_max_heading_level?: number;
+    pagination_next?: string | null;
+    pagination_prev?: string | null;
 };
 export declare type DocMetadataBase = LastUpdateData & {
     version: VersionName;
@@ -152,6 +121,7 @@ export declare type DocMetadataBase = LastUpdateData & {
     permalink: string;
     sidebarPosition?: number;
     editUrl?: string | null;
+    tags: Tag[];
     frontMatter: DocFrontMatter & Record<string, unknown>;
 };
 export declare type DocNavLink = {
@@ -166,12 +136,19 @@ export declare type DocMetadata = DocMetadataBase & {
 export declare type SourceToPermalink = {
     [source: string]: string;
 };
+export declare type VersionTag = {
+    name: string;
+    docIds: string[];
+    permalink: string;
+};
+export declare type VersionTags = {
+    [key: string]: VersionTag;
+};
 export declare type LoadedVersion = VersionMetadata & {
     versionPath: string;
     mainDocId: string;
     docs: DocMetadata[];
     sidebars: Sidebars;
-    permalinkToSidebar: Record<string, string>;
 };
 export declare type LoadedContent = {
     loadedVersions: LoadedVersion[];

package/lib/versions.d.ts

@@ -11,6 +11,6 @@ export declare function getVersionedSidebarsDirPath(siteDir: string, pluginId: s
 export declare function getVersionsFilePath(siteDir: string, pluginId: string): string;
 export declare function readVersionsMetadata({ context, options, }: {
     context: Pick<LoadContext, 'siteDir' | 'baseUrl' | 'i18n'>;
-    options: Pick<PluginOptions, 'id' | 'path' | 'sidebarPath' | 'routeBasePath' | 'includeCurrentVersion' | 'disableVersioning' | 'lastVersion' | 'versions' | 'onlyIncludeVersions' | 'editUrl' | 'editCurrentVersion'>;
+    options: Pick<PluginOptions, 'id' | 'path' | 'sidebarPath' | 'routeBasePath' | 'tagsBasePath' | 'includeCurrentVersion' | 'disableVersioning' | 'lastVersion' | 'versions' | 'onlyIncludeVersions' | 'editUrl' | 'editCurrentVersion'>;
 }): VersionMetadata[];
 export declare function getDocsDirPaths(versionMetadata: Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized'>): [string, string];

package/lib/versions.js

@@ -8,8 +8,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDocsDirPaths = exports.readVersionsMetadata = exports.getVersionsFilePath = exports.getVersionedSidebarsDirPath = exports.getVersionedDocsDirPath = void 0;
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const constants_1 = require("./constants");
 const constants_2 = require("@docusaurus/core/lib/constants");
 const utils_1 = require("@docusaurus/utils");
@@ -83,7 +83,7 @@ function readVersionNames(siteDir, options) {
     return versions;
 }
 function getDocsDirPathLocalized({ siteDir, locale, pluginId, versionName, }) {
-    return utils_1.getPluginI18nPath({
+    return (0, utils_1.getPluginI18nPath)({
         siteDir,
         locale,
         pluginName: 'docusaurus-plugin-content-docs',
@@ -108,7 +108,7 @@ function getVersionMetadataPaths({ versionName, context, options, }) {
     });
     function getSidebarFilePath() {
         if (isCurrentVersion) {
-            return sidebars_1.resolveSidebarPathOption(context.siteDir, options.sidebarPath);
+            return (0, sidebars_1.resolveSidebarPathOption)(context.siteDir, options.sidebarPath);
         }
         else {
             return path_1.default.join(getVersionedSidebarsDirPath(context.siteDir, options.id), `version-${versionName}-sidebars.json`);
@@ -138,10 +138,10 @@ function getVersionEditUrls({ contentPath, contentPathLocalized, context: { site
             pluginId: id,
         })
         : contentPathLocalized;
-    const versionPathSegment = utils_1.posixPath(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPath)));
-    const versionPathSegmentLocalized = utils_1.posixPath(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPathLocalized)));
-    const versionEditUrl = utils_1.normalizeUrl([editUrl, versionPathSegment]);
-    const versionEditUrlLocalized = utils_1.normalizeUrl([
+    const versionPathSegment = (0, utils_1.posixPath)(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPath)));
+    const versionPathSegmentLocalized = (0, utils_1.posixPath)(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPathLocalized)));
+    const versionEditUrl = (0, utils_1.normalizeUrl)([editUrl, versionPathSegment]);
+    const versionEditUrlLocalized = (0, utils_1.normalizeUrl)([
         editUrl,
         versionPathSegmentLocalized,
     ]);
@@ -150,24 +150,64 @@ function getVersionEditUrls({ contentPath, contentPathLocalized, context: { site
         versionEditUrlLocalized,
     };
 }
-function createVersionMetadata({ versionName, isLast, context, options, }) {
-    var _a, _b, _c;
-    const { sidebarFilePath, contentPath, contentPathLocalized, } = getVersionMetadataPaths({
+function getDefaultVersionBanner({ versionName, versionNames, lastVersionName, }) {
+    // Current version: good, no banner
+    if (versionName === lastVersionName) {
+        return null;
+    }
+    // Upcoming versions: unreleased banner
+    else if (versionNames.indexOf(versionName) < versionNames.indexOf(lastVersionName)) {
+        return 'unreleased';
+    }
+    // Older versions: display unmaintained banner
+    else {
+        return 'unmaintained';
+    }
+}
+function getVersionBanner({ versionName, versionNames, lastVersionName, options, }) {
+    var _a;
+    const versionBannerOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.banner;
+    if (versionBannerOption) {
+        return versionBannerOption === 'none' ? null : versionBannerOption;
+    }
+    return getDefaultVersionBanner({
         versionName,
-        context,
-        options,
+        versionNames,
+        lastVersionName,
     });
+}
+function getVersionBadge({ versionName, versionNames, options, }) {
+    var _a;
+    const versionBadgeOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.badge;
+    // If site is not versioned or only one version is included
+    // we don't show the version badge by default
+    // See https://github.com/facebook/docusaurus/issues/3362
+    const versionBadgeDefault = versionNames.length !== 1;
+    return versionBadgeOption !== null && versionBadgeOption !== void 0 ? versionBadgeOption : versionBadgeDefault;
+}
+function getVersionClassName({ versionName, options, }) {
+    var _a;
+    const versionClassNameOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.className;
+    const versionClassNameDefault = `docs-version-${versionName}`;
+    return versionClassNameOption !== null && versionClassNameOption !== void 0 ? versionClassNameOption : versionClassNameDefault;
+}
+function createVersionMetadata({ versionName, versionNames, lastVersionName, context, options, }) {
+    var _a, _b, _c;
+    const { sidebarFilePath, contentPath, contentPathLocalized } = getVersionMetadataPaths({ versionName, context, options });
+    const isLast = versionName === lastVersionName;
     // retro-compatible values
     const defaultVersionLabel = versionName === constants_1.CURRENT_VERSION_NAME ? 'Next' : versionName;
-    const defaultVersionPathPart = isLast
-        ? ''
-        : versionName === constants_1.CURRENT_VERSION_NAME
-            ? 'next'
-            : versionName;
+    function getDefaultVersionPathPart() {
+        if (isLast) {
+            return '';
+        }
+        return versionName === constants_1.CURRENT_VERSION_NAME ? 'next' : versionName;
+    }
+    const defaultVersionPathPart = getDefaultVersionPathPart();
     const versionOptions = (_a = options.versions[versionName]) !== null && _a !== void 0 ? _a : {};
     const versionLabel = (_b = versionOptions.label) !== null && _b !== void 0 ? _b : defaultVersionLabel;
     const versionPathPart = (_c = versionOptions.path) !== null && _c !== void 0 ? _c : defaultVersionPathPart;
-    const versionPath = utils_1.normalizeUrl([
+    const versionPath = (0, utils_1.normalizeUrl)([
         context.baseUrl,
         options.routeBasePath,
         versionPathPart,
@@ -180,12 +220,24 @@ function createVersionMetadata({ versionName, isLast, context, options, }) {
     });
     // Because /docs/:route` should always be after `/docs/versionName/:route`.
     const routePriority = versionPathPart === '' ? -1 : undefined;
+    // the path that will be used to refer the docs tags
+    // example below will be using /docs/tags
+    const tagsPath = (0, utils_1.normalizeUrl)([versionPath, options.tagsBasePath]);
     return {
         versionName,
         versionLabel,
         versionPath,
+        tagsPath,
         versionEditUrl: versionEditUrls === null || versionEditUrls === void 0 ? void 0 : versionEditUrls.versionEditUrl,
         versionEditUrlLocalized: versionEditUrls === null || versionEditUrls === void 0 ? void 0 : versionEditUrls.versionEditUrlLocalized,
+        versionBanner: getVersionBanner({
+            versionName,
+            versionNames,
+            lastVersionName,
+            options,
+        }),
+        versionBadge: getVersionBadge({ versionName, versionNames, options }),
+        versionClassName: getVersionClassName({ versionName, options }),
         isLast,
         routePriority,
         sidebarFilePath,
@@ -231,7 +283,7 @@ function checkVersionsOptions(availableVersionNames, options) {
         !availableVersionNames.includes(options.lastVersion)) {
         throw new Error(`Docs option lastVersion=${options.lastVersion} is invalid. ${availableVersionNamesMsg}`);
     }
-    const unknownVersionConfigNames = lodash_1.difference(Object.keys(options.versions), availableVersionNames);
+    const unknownVersionConfigNames = (0, lodash_1.difference)(Object.keys(options.versions), availableVersionNames);
     if (unknownVersionConfigNames.length > 0) {
         throw new Error(`Invalid docs option "versions": unknown versions (${unknownVersionConfigNames.join(',')}) found. ${availableVersionNamesMsg}`);
     }
@@ -239,7 +291,7 @@ function checkVersionsOptions(availableVersionNames, options) {
         if (options.onlyIncludeVersions.length === 0) {
             throw new Error(`Invalid docs option "onlyIncludeVersions": an empty array is not allowed, at least one version is needed.`);
         }
-        const unknownOnlyIncludeVersionNames = lodash_1.difference(options.onlyIncludeVersions, availableVersionNames);
+        const unknownOnlyIncludeVersionNames = (0, lodash_1.difference)(options.onlyIncludeVersions, availableVersionNames);
         if (unknownOnlyIncludeVersionNames.length > 0) {
             throw new Error(`Invalid docs option "onlyIncludeVersions": unknown versions (${unknownOnlyIncludeVersionNames.join(',')}) found. ${availableVersionNamesMsg}`);
         }
@@ -269,7 +321,8 @@ function readVersionsMetadata({ context, options, }) {
     const lastVersionName = (_a = options.lastVersion) !== null && _a !== void 0 ? _a : getDefaultLastVersionName(versionNames);
     const versionsMetadata = versionNames.map((versionName) => createVersionMetadata({
         versionName,
-        isLast: versionName === lastVersionName,
+        versionNames,
+        lastVersionName,
         context,
         options,
     }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "2.0.0-beta.8bda3b2db",
+  "version": "2.0.0-beta.9",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-docs.d.ts",
@@ -18,19 +18,20 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.8bda3b2db",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.9",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
-    "picomatch": "^2.1.1"
+    "picomatch": "^2.1.1",
+    "utility-types": "^3.10.0"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.8bda3b2db",
-    "@docusaurus/mdx-loader": "2.0.0-beta.8bda3b2db",
-    "@docusaurus/types": "2.0.0-beta.8bda3b2db",
-    "@docusaurus/utils": "2.0.0-beta.8bda3b2db",
-    "@docusaurus/utils-validation": "2.0.0-beta.8bda3b2db",
-    "chalk": "^4.1.1",
+    "@docusaurus/core": "2.0.0-beta.9",
+    "@docusaurus/mdx-loader": "2.0.0-beta.9",
+    "@docusaurus/types": "2.0.0-beta.9",
+    "@docusaurus/utils": "2.0.0-beta.9",
+    "@docusaurus/utils-validation": "2.0.0-beta.9",
+    "chalk": "^4.1.2",
     "combine-promises": "^1.1.0",
     "escape-string-regexp": "^4.0.0",
     "execa": "^5.0.0",
@@ -38,20 +39,20 @@
     "globby": "^11.0.2",
     "import-fresh": "^3.2.2",
     "js-yaml": "^4.0.0",
-    "loader-utils": "^1.2.3",
+    "loader-utils": "^2.0.0",
     "lodash": "^4.17.20",
     "remark-admonitions": "^1.2.1",
     "shelljs": "^0.8.4",
-    "tslib": "^2.2.0",
+    "tslib": "^2.3.1",
     "utility-types": "^3.10.0",
-    "webpack": "^5.37.0"
+    "webpack": "^5.61.0"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "11a61b194f840ae0d554849a71c0d9447ef770af"
+  "gitHead": "8a491fc29ad002f90e97f5b5fe4178ac8fa0c4d7"
 }

package/src/__tests__/__fixtures__/simple-site/docs/_partials/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/simple-site/docs/_partials/subfolder/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/simple-site/docs/_somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with \_:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md

@@ -3,6 +3,11 @@ id: baz
 title: baz
 slug: bazSlug.html
 pagination_label: baz pagination_label
+tags:
+  - tag 1
+  - tag-1
+  - label: tag 2
+    permalink: tag2-custom-permalink
 ---
 
 # Baz markdown title

package/src/__tests__/__fixtures__/simple-site/docs/hello.md

@@ -2,6 +2,7 @@
 id: hello
 title: Hello, World !
 sidebar_label: Hello sidebar_label
+tags: [tag-1, tag 3]
 ---
 
 Hi, Endilie here :)

package/src/__tests__/__fixtures__/simple-site/docs/rootAbsoluteSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: /rootAbsoluteSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/docs/rootRelativeSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: rootRelativeSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/docs/rootResolvedSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: ./hey/ho/../rootResolvedSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/docs/rootTryToEscapeSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: ../../../../../../../../rootTryToEscapeSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/sidebars.json

@@ -4,7 +4,21 @@
       {
         "type": "category",
         "label": "foo",
-        "items": ["foo/bar", "foo/baz"] 
+        "items": ["foo/bar", "foo/baz"]
+      },
+      {
+        "type": "category",
+        "label": "Slugs",
+        "items": [
+          "rootAbsoluteSlug",
+          "rootRelativeSlug",
+          "rootResolvedSlug",
+          "rootTryToEscapeSlug"
+        ]
+      },
+      {
+        "type": "doc",
+        "id": "headingAsTitle"
       },
       {
         "type": "link",

package/src/__tests__/__fixtures__/versioned-site/docs/foo/bar.md

@@ -1,4 +1,10 @@
 ---
 slug: barSlug
+tags:
+  - barTag 1
+  - barTag-2
+  - label: barTag 3
+    permalink: barTag-3-permalink
 ---
+
 This is `next` version of bar.

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/_partials/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/_partials/subfolder/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/_somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with \_:
+
+It should be excluded by default

package/src/__tests__/__snapshots__/cli.test.ts.snap

@@ -5,9 +5,11 @@ Object {
   "version-1.0.0/docs": Array [
     Object {
       "collapsed": true,
+      "collapsible": true,
       "items": Array [
         Object {
           "collapsed": true,
+          "collapsible": true,
           "items": Array [
             Object {
               "id": "version-1.0.0/foo/bar",
@@ -21,6 +23,34 @@ Object {
           "label": "foo",
           "type": "category",
         },
+        Object {
+          "collapsed": true,
+          "collapsible": true,
+          "items": Array [
+            Object {
+              "id": "version-1.0.0/rootAbsoluteSlug",
+              "type": "doc",
+            },
+            Object {
+              "id": "version-1.0.0/rootRelativeSlug",
+              "type": "doc",
+            },
+            Object {
+              "id": "version-1.0.0/rootResolvedSlug",
+              "type": "doc",
+            },
+            Object {
+              "id": "version-1.0.0/rootTryToEscapeSlug",
+              "type": "doc",
+            },
+          ],
+          "label": "Slugs",
+          "type": "category",
+        },
+        Object {
+          "id": "version-1.0.0/headingAsTitle",
+          "type": "doc",
+        },
         Object {
           "href": "https://github.com",
           "label": "Github",
@@ -36,6 +66,7 @@ Object {
     },
     Object {
       "collapsed": true,
+      "collapsible": true,
       "items": Array [
         Object {
           "id": "version-1.0.0/hello",
@@ -54,6 +85,7 @@ Object {
   "version-2.0.0/docs": Array [
     Object {
       "collapsed": true,
+      "collapsible": true,
       "items": Array [
         Object {
           "id": "version-2.0.0/foo/bar",
@@ -65,6 +97,7 @@ Object {
     },
     Object {
       "collapsed": true,
+      "collapsible": true,
       "items": Array [
         Object {
           "id": "version-2.0.0/hello",