@docusaurus/plugin-content-docs 0.0.0-4836 → 0.0.0-4839

package/lib/index.js

@@ -138,12 +138,12 @@ async function pluginContentDocs(context, options) {
                 // TODO tags should be a sub route of the version route
                 async function createTagsListPage() {
                     const tagsProp = Object.values(versionTags).map((tagValue) => ({
-                        name: tagValue.label,
+                        label: tagValue.label,
                         permalink: tagValue.permalink,
                         count: tagValue.docIds.length,
                     }));
                     // Only create /tags page if there are tags.
-                    if (Object.keys(tagsProp).length > 0) {
+                    if (tagsProp.length > 0) {
                         const tagsPropPath = await createData(`${(0, utils_1.docuHash)(`tags-list-${version.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
                         addRoute({
                             path: version.tagsPath,

package/lib/props.d.ts

@@ -11,5 +11,5 @@ export declare function toVersionMetadataProp(pluginId: string, loadedVersion: L
 export declare function toTagDocListProp({ allTagsPath, tag, docs, }: {
     allTagsPath: string;
     tag: VersionTag;
-    docs: Pick<DocMetadata, 'id' | 'title' | 'description' | 'permalink'>[];
+    docs: DocMetadata[];
 }): PropTagDocList;

package/lib/props.js

@@ -104,10 +104,11 @@ function toTagDocListProp({ allTagsPath, tag, docs, }) {
         }));
     }
     return {
-        name: tag.label,
+        label: tag.label,
         permalink: tag.permalink,
-        docs: toDocListProp(),
         allTagsPath,
+        count: tag.docIds.length,
+        items: toDocListProp(),
     };
 }
 exports.toTagDocListProp = toTagDocListProp;

package/lib/types.d.ts

@@ -5,8 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars } from './sidebars/types';
-import type { BrokenMarkdownLink, Tag } from '@docusaurus/utils';
+import type { BrokenMarkdownLink } from '@docusaurus/utils';
 import type { VersionMetadata, LastUpdateData, DocMetadata, CategoryGeneratedIndexMetadata } from '@docusaurus/plugin-content-docs';
+import type { Tag } from '@docusaurus/types';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -22,7 +23,7 @@ export declare type VersionTag = Tag & {
     docIds: string[];
 };
 export declare type VersionTags = {
-    [key: string]: VersionTag;
+    [permalink: string]: VersionTag;
 };
 export declare type LoadedVersion = VersionMetadata & {
     mainDocId: string;

package/package.json

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

package/src/index.ts

@@ -228,13 +228,13 @@ export default async function pluginContentDocs(
           const tagsProp: PropTagsListPage['tags'] = Object.values(
             versionTags,
           ).map((tagValue) => ({
-            name: tagValue.label,
+            label: tagValue.label,
             permalink: tagValue.permalink,
             count: tagValue.docIds.length,
           }));
 
           // Only create /tags page if there are tags.
-          if (Object.keys(tagsProp).length > 0) {
+          if (tagsProp.length > 0) {
             const tagsPropPath = await createData(
               `${docuHash(`tags-list-${version.versionName}-prop`)}.json`,
               JSON.stringify(tagsProp, null, 2),

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

@@ -7,7 +7,8 @@
 
 declare module '@docusaurus/plugin-content-docs' {
   import type {MDXOptions} from '@docusaurus/mdx-loader';
-  import type {ContentPaths, Tag, FrontMatterTag} from '@docusaurus/utils';
+  import type {ContentPaths, FrontMatterTag} from '@docusaurus/utils';
+  import type {TagsListItem, TagModule, Tag} from '@docusaurus/types';
   import type {Required} from 'utility-types';
 
   export type Assets = {
@@ -483,25 +484,14 @@ declare module '@docusaurus/plugin-content-docs' {
   export type PropSidebar = import('./sidebars/types').PropSidebar;
   export type PropSidebars = import('./sidebars/types').PropSidebars;
 
-  export type PropTagDocListDoc = {
-    id: string;
-    title: string;
-    description: string;
-    permalink: string;
-  };
-  export type PropTagDocList = {
-    allTagsPath: string;
-    name: string; // normalized name/label of the tag
-    permalink: string; // pathname of the tag
-    docs: PropTagDocListDoc[];
-  };
+  export type PropTagDocListDoc = Pick<
+    DocMetadata,
+    'id' | 'title' | 'description' | 'permalink'
+  >;
+  export type PropTagDocList = TagModule & {items: PropTagDocListDoc[]};
 
   export type PropTagsListPage = {
-    tags: {
-      name: string;
-      permalink: string;
-      count: number;
-    }[];
+    tags: TagsListItem[];
   };
 }
 

package/src/props.ts

@@ -137,7 +137,7 @@ export function toTagDocListProp({
 }: {
   allTagsPath: string;
   tag: VersionTag;
-  docs: Pick<DocMetadata, 'id' | 'title' | 'description' | 'permalink'>[];
+  docs: DocMetadata[];
 }): PropTagDocList {
   function toDocListProp(): PropTagDocListDoc[] {
     const list = _.compact(
@@ -154,9 +154,10 @@ export function toTagDocListProp({
   }
 
   return {
-    name: tag.label,
+    label: tag.label,
     permalink: tag.permalink,
-    docs: toDocListProp(),
     allTagsPath,
+    count: tag.docIds.length,
+    items: toDocListProp(),
   };
 }

package/src/types.ts

@@ -8,13 +8,14 @@
 /// <reference types="@docusaurus/module-type-aliases" />
 
 import type {Sidebars} from './sidebars/types';
-import type {BrokenMarkdownLink, Tag} from '@docusaurus/utils';
+import type {BrokenMarkdownLink} from '@docusaurus/utils';
 import type {
   VersionMetadata,
   LastUpdateData,
   DocMetadata,
   CategoryGeneratedIndexMetadata,
 } from '@docusaurus/plugin-content-docs';
+import type {Tag} from '@docusaurus/types';
 
 export type DocFile = {
   contentPath: string; // /!\ may be localized
@@ -33,7 +34,7 @@ export type VersionTag = Tag & {
   docIds: string[];
 };
 export type VersionTags = {
-  [key: string]: VersionTag;
+  [permalink: string]: VersionTag;
 };
 
 export type LoadedVersion = VersionMetadata & {