feat(content-docs): add last update front matter

facebook · May 22, 2022 · 9a9248d · 9a9248d
1 parent a34b2a2
commit 9a9248d
Show file tree

Hide file tree

Showing 14 changed files with 434 additions and 5 deletions.
diff --git a/...in-content-docs/src/__tests__/__fixtures__/simple-site/docs/customLastUpdate.md b/...in-content-docs/src/__tests__/__fixtures__/simple-site/docs/customLastUpdate.md
diff --git a/...ontent-docs/src/__tests__/__fixtures__/simple-site/docs/lastUpdateAuthorOnly.md b/...ontent-docs/src/__tests__/__fixtures__/simple-site/docs/lastUpdateAuthorOnly.md
diff --git a/...-content-docs/src/__tests__/__fixtures__/simple-site/docs/lastUpdateDateOnly.md b/...-content-docs/src/__tests__/__fixtures__/simple-site/docs/lastUpdateDateOnly.md
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap
@@ -3,13 +3,24 @@
 exports[`simple site custom pagination 1`] = `
 {
   "pagination": [
+    {
+      "id": "customLastUpdate",
+      "next": {
+        "permalink": "/docs/doc with space",
+        "title": "Hoo hoo, if this path tricks you...",
+      },
+      "prev": undefined,
+    },
     {
       "id": "doc with space",
       "next": {
         "permalink": "/docs/doc-draft",
         "title": "doc-draft",
       },
-      "prev": undefined,
+      "prev": {
+        "permalink": "/docs/customLastUpdate",
+        "title": "Custom Last Update",
+      },
     },
     {
       "id": "doc-draft",
@@ -63,23 +74,45 @@ exports[`simple site custom pagination 1`] = `
     {
       "id": "ipsum",
       "next": {
-        "permalink": "/docs/lorem",
-        "title": "lorem",
+        "permalink": "/docs/lastUpdateAuthorOnly",
+        "title": "Last Update Author Only",
       },
       "prev": {
         "permalink": "/docs/",
         "title": "Hello sidebar_label",
       },
     },
+    {
+      "id": "lastUpdateAuthorOnly",
+      "next": {
+        "permalink": "/docs/lastUpdateDateOnly",
+        "title": "Last Update Date Only",
+      },
+      "prev": {
+        "permalink": "/docs/ipsum",
+        "title": "ipsum",
+      },
+    },
+    {
+      "id": "lastUpdateDateOnly",
+      "next": {
+        "permalink": "/docs/lorem",
+        "title": "lorem",
+      },
+      "prev": {
+        "permalink": "/docs/lastUpdateAuthorOnly",
+        "title": "Last Update Author Only",
+      },
+    },
     {
       "id": "lorem",
       "next": {
         "permalink": "/docs/rootAbsoluteSlug",
         "title": "rootAbsoluteSlug",
       },
       "prev": {
-        "permalink": "/docs/ipsum",
-        "title": "ipsum",
+        "permalink": "/docs/lastUpdateDateOnly",
+        "title": "Last Update Date Only",
       },
     },
     {
@@ -170,6 +203,10 @@ exports[`simple site custom pagination 1`] = `
   ],
   "sidebars": {
     "defaultSidebar": [
+      {
+        "id": "customLastUpdate",
+        "type": "doc",
+      },
       {
         "id": "doc with space",
         "type": "doc",
@@ -208,6 +245,14 @@ exports[`simple site custom pagination 1`] = `
         "id": "ipsum",
         "type": "doc",
       },
+      {
+        "id": "lastUpdateAuthorOnly",
+        "type": "doc",
+      },
+      {
+        "id": "lastUpdateDateOnly",
+        "type": "doc",
+      },
       {
         "id": "lorem",
         "type": "doc",

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
@@ -22,13 +22,16 @@ These sidebar document ids do not exist:
 - nonExistent
 
 Available document ids are:
+- customLastUpdate
 - doc with space
 - doc-draft
 - foo/bar
 - foo/baz
 - headingAsTitle
 - hello
 - ipsum
+- lastUpdateAuthorOnly
+- lastUpdateDateOnly
 - lorem
 - rootAbsoluteSlug
 - rootRelativeSlug
@@ -267,6 +270,11 @@ exports[`simple website content 5`] = `
       "versions": [
         {
           "docs": [
+            {
+              "id": "customLastUpdate",
+              "path": "/docs/customLastUpdate",
+              "sidebar": undefined,
+            },
             {
               "id": "doc with space",
               "path": "/docs/doc with space",
@@ -302,6 +310,16 @@ exports[`simple website content 5`] = `
               "path": "/docs/ipsum",
               "sidebar": undefined,
             },
+            {
+              "id": "lastUpdateAuthorOnly",
+              "path": "/docs/lastUpdateAuthorOnly",
+              "sidebar": undefined,
+            },
+            {
+              "id": "lastUpdateDateOnly",
+              "path": "/docs/lastUpdateDateOnly",
+              "sidebar": undefined,
+            },
             {
               "id": "lorem",
               "path": "/docs/lorem",
@@ -390,6 +408,26 @@ exports[`simple website content: data 1`] = `
       "permalink": "/docs/rootAbsoluteSlug"
     }
   }
+}",
+  "site-docs-custom-last-update-md-b8d.json": "{
+  "unversionedId": "customLastUpdate",
+  "id": "customLastUpdate",
+  "title": "Custom Last Update",
+  "description": "Custom last update",
+  "source": "@site/docs/customLastUpdate.md",
+  "sourceDirName": ".",
+  "slug": "/customLastUpdate",
+  "permalink": "/docs/customLastUpdate",
+  "draft": false,
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "title": "Custom Last Update",
+    "last_update": {
+      "author": "Custom Author",
+      "date": "1/1/2000"
+    }
+  }
 }",
   "site-docs-doc-draft-md-584.json": "{
   "unversionedId": "doc-draft",
@@ -563,6 +601,44 @@ exports[`simple website content: data 1`] = `
   "frontMatter": {
     "custom_edit_url": null
   }
+}",
+  "site-docs-last-update-author-only-md-352.json": "{
+  "unversionedId": "lastUpdateAuthorOnly",
+  "id": "lastUpdateAuthorOnly",
+  "title": "Last Update Author Only",
+  "description": "Only custom author, so it will still use the date from Git",
+  "source": "@site/docs/lastUpdateAuthorOnly.md",
+  "sourceDirName": ".",
+  "slug": "/lastUpdateAuthorOnly",
+  "permalink": "/docs/lastUpdateAuthorOnly",
+  "draft": false,
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "title": "Last Update Author Only",
+    "last_update": {
+      "author": "Custom Author"
+    }
+  }
+}",
+  "site-docs-last-update-date-only-md-987.json": "{
+  "unversionedId": "lastUpdateDateOnly",
+  "id": "lastUpdateDateOnly",
+  "title": "Last Update Date Only",
+  "description": "Only custom date, so it will still use the author from Git",
+  "source": "@site/docs/lastUpdateDateOnly.md",
+  "sourceDirName": ".",
+  "slug": "/lastUpdateDateOnly",
+  "permalink": "/docs/lastUpdateDateOnly",
+  "draft": false,
+  "tags": [],
+  "version": "current",
+  "frontMatter": {
+    "title": "Last Update Date Only",
+    "last_update": {
+      "date": "1/1/2000"
+    }
+  }
 }",
   "site-docs-lorem-md-b27.json": "{
   "unversionedId": "lorem",
@@ -924,6 +1000,11 @@ exports[`simple website content: data 1`] = `
     ]
   },
   "docs": {
+    "customLastUpdate": {
+      "id": "customLastUpdate",
+      "title": "Custom Last Update",
+      "description": "Custom last update"
+    },
     "doc with space": {
       "id": "doc with space",
       "title": "Hoo hoo, if this path tricks you...",
@@ -963,6 +1044,16 @@ exports[`simple website content: data 1`] = `
       "title": "ipsum",
       "description": "Lorem ipsum."
     },
+    "lastUpdateAuthorOnly": {
+      "id": "lastUpdateAuthorOnly",
+      "title": "Last Update Author Only",
+      "description": "Only custom author, so it will still use the date from Git"
+    },
+    "lastUpdateDateOnly": {
+      "id": "lastUpdateDateOnly",
+      "title": "Last Update Date Only",
+      "description": "Only custom date, so it will still use the author from Git"
+    },
     "lorem": {
       "id": "lorem",
       "title": "lorem",
@@ -1026,6 +1117,11 @@ exports[`simple website content: global data 1`] = `
       "versions": [
         {
           "docs": [
+            {
+              "id": "customLastUpdate",
+              "path": "/docs/customLastUpdate",
+              "sidebar": undefined,
+            },
             {
               "id": "doc with space",
               "path": "/docs/doc with space",
@@ -1061,6 +1157,16 @@ exports[`simple website content: global data 1`] = `
               "path": "/docs/ipsum",
               "sidebar": undefined,
             },
+            {
+              "id": "lastUpdateAuthorOnly",
+              "path": "/docs/lastUpdateAuthorOnly",
+              "sidebar": undefined,
+            },
+            {
+              "id": "lastUpdateDateOnly",
+              "path": "/docs/lastUpdateDateOnly",
+              "sidebar": undefined,
+            },
             {
               "id": "lorem",
               "path": "/docs/lorem",
@@ -1202,6 +1308,14 @@ exports[`simple website content: route config 1`] = `
         "path": "/docs/category/slugs",
         "sidebar": "docs",
       },
+      {
+        "component": "@theme/DocItem",
+        "exact": true,
+        "modules": {
+          "content": "@site/docs/customLastUpdate.md",
+        },
+        "path": "/docs/customLastUpdate",
+      },
       {
         "component": "@theme/DocItem",
         "exact": true,
@@ -1262,6 +1376,22 @@ exports[`simple website content: route config 1`] = `
         },
         "path": "/docs/ipsum",
       },
+      {
+        "component": "@theme/DocItem",
+        "exact": true,
+        "modules": {
+          "content": "@site/docs/lastUpdateAuthorOnly.md",
+        },
+        "path": "/docs/lastUpdateAuthorOnly",
+      },
+      {
+        "component": "@theme/DocItem",
+        "exact": true,
+        "modules": {
+          "content": "@site/docs/lastUpdateDateOnly.md",
+        },
+        "path": "/docs/lastUpdateDateOnly",
+      },
       {
         "component": "@theme/DocItem",
         "exact": true,