@docusaurus/plugin-content-blog 0.0.0-5865 → 0.0.0-5866

package/lib/blogUtils.js

@@ -127,6 +127,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
         parseFrontMatter,
     });
     const aliasedSource = (0, utils_1.aliasedSitePath)(blogSourceAbsolute, siteDir);
+    const lastUpdate = await (0, utils_1.readLastUpdateData)(blogSourceAbsolute, options, frontMatter.last_update);
     const draft = (0, utils_1.isDraft)({ frontMatter });
     const unlisted = (0, utils_1.isUnlisted)({ frontMatter });
     if (draft) {
@@ -216,6 +217,8 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
             authors,
             frontMatter,
             unlisted,
+            lastUpdatedAt: lastUpdate.lastUpdatedAt,
+            lastUpdatedBy: lastUpdate.lastUpdatedBy,
         },
         content,
     };

package/lib/frontMatter.d.ts

@@ -1,9 +1,3 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
 import type { BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
 export declare function validateBlogPostFrontMatter(frontMatter: {
     [key: string]: unknown;

package/lib/frontMatter.js

@@ -1,12 +1,12 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateBlogPostFrontMatter = void 0;
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateBlogPostFrontMatter = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const BlogPostFrontMatterAuthorSchema = utils_validation_1.JoiFrontMatter.object({
     key: utils_validation_1.JoiFrontMatter.string(),
@@ -52,6 +52,7 @@ const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     keywords: utils_validation_1.JoiFrontMatter.array().items(utils_validation_1.JoiFrontMatter.string().required()),
     hide_table_of_contents: utils_validation_1.JoiFrontMatter.boolean(),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,
+    last_update: utils_validation_1.FrontMatterLastUpdateSchema,
 })
     .messages({
     'deprecate.error': '{#label} blog frontMatter field is deprecated. Please use {#alternative} instead.',

package/lib/options.js

@@ -39,6 +39,8 @@ exports.DEFAULT_OPTIONS = {
     authorsMapPath: 'authors.yml',
     readingTime: ({ content, defaultReadingTime }) => defaultReadingTime({ content }),
     sortPosts: 'descending',
+    showLastUpdateTime: false,
+    showLastUpdateAuthor: false,
     processBlogPosts: async () => undefined,
 };
 const PluginOptionSchema = utils_validation_1.Joi.object({
@@ -104,6 +106,8 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     sortPosts: utils_validation_1.Joi.string()
         .valid('descending', 'ascending')
         .default(exports.DEFAULT_OPTIONS.sortPosts),
+    showLastUpdateTime: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.showLastUpdateTime),
+    showLastUpdateAuthor: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.showLastUpdateAuthor),
     processBlogPosts: utils_validation_1.Joi.function()
         .optional()
         .default(() => exports.DEFAULT_OPTIONS.processBlogPosts),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5865",
+  "version": "0.0.0-5866",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,13 +31,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5865",
-    "@docusaurus/logger": "0.0.0-5865",
-    "@docusaurus/mdx-loader": "0.0.0-5865",
-    "@docusaurus/types": "0.0.0-5865",
-    "@docusaurus/utils": "0.0.0-5865",
-    "@docusaurus/utils-common": "0.0.0-5865",
-    "@docusaurus/utils-validation": "0.0.0-5865",
+    "@docusaurus/core": "0.0.0-5866",
+    "@docusaurus/logger": "0.0.0-5866",
+    "@docusaurus/mdx-loader": "0.0.0-5866",
+    "@docusaurus/types": "0.0.0-5866",
+    "@docusaurus/utils": "0.0.0-5866",
+    "@docusaurus/utils-common": "0.0.0-5866",
+    "@docusaurus/utils-validation": "0.0.0-5866",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -59,5 +59,5 @@
   "devDependencies": {
     "@total-typescript/shoehorn": "^0.1.2"
   },
-  "gitHead": "0ce2912136d682daeb3abe9d1284a49f9c011efa"
+  "gitHead": "0066496d0f98e8f9e4e4636130f26723bdc8f3c7"
 }

package/src/blogUtils.ts

@@ -26,6 +26,7 @@ import {
   getContentPathList,
   isUnlisted,
   isDraft,
+  readLastUpdateData,
 } from '@docusaurus/utils';
 import {validateBlogPostFrontMatter} from './frontMatter';
 import {type AuthorsMap, getAuthorsMap, getBlogPostAuthors} from './authors';
@@ -231,6 +232,12 @@ async function processBlogSourceFile(
 
   const aliasedSource = aliasedSitePath(blogSourceAbsolute, siteDir);
 
+  const lastUpdate = await readLastUpdateData(
+    blogSourceAbsolute,
+    options,
+    frontMatter.last_update,
+  );
+
   const draft = isDraft({frontMatter});
   const unlisted = isUnlisted({frontMatter});
 
@@ -337,6 +344,8 @@ async function processBlogSourceFile(
       authors,
       frontMatter,
       unlisted,
+      lastUpdatedAt: lastUpdate.lastUpdatedAt,
+      lastUpdatedBy: lastUpdate.lastUpdatedBy,
     },
     content,
   };

package/src/frontMatter.ts

@@ -4,14 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
 import {
+  ContentVisibilitySchema,
+  FrontMatterLastUpdateSchema,
+  FrontMatterTOCHeadingLevels,
+  FrontMatterTagsSchema,
   JoiFrontMatter as Joi, // Custom instance for front matter
   URISchema,
   validateFrontMatter,
-  FrontMatterTagsSchema,
-  FrontMatterTOCHeadingLevels,
-  ContentVisibilitySchema,
 } from '@docusaurus/utils-validation';
 import type {BlogPostFrontMatter} from '@docusaurus/plugin-content-blog';
 
@@ -69,6 +69,7 @@ const BlogFrontMatterSchema = Joi.object<BlogPostFrontMatter>({
   hide_table_of_contents: Joi.boolean(),
 
   ...FrontMatterTOCHeadingLevels,
+  last_update: FrontMatterLastUpdateSchema,
 })
   .messages({
     'deprecate.error':

package/src/options.ts

@@ -51,6 +51,8 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   authorsMapPath: 'authors.yml',
   readingTime: ({content, defaultReadingTime}) => defaultReadingTime({content}),
   sortPosts: 'descending',
+  showLastUpdateTime: false,
+  showLastUpdateAuthor: false,
   processBlogPosts: async () => undefined,
 };
 
@@ -135,6 +137,10 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
   sortPosts: Joi.string()
     .valid('descending', 'ascending')
     .default(DEFAULT_OPTIONS.sortPosts),
+  showLastUpdateTime: Joi.bool().default(DEFAULT_OPTIONS.showLastUpdateTime),
+  showLastUpdateAuthor: Joi.bool().default(
+    DEFAULT_OPTIONS.showLastUpdateAuthor,
+  ),
   processBlogPosts: Joi.function()
     .optional()
     .default(() => DEFAULT_OPTIONS.processBlogPosts),

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

@@ -10,7 +10,12 @@
 declare module '@docusaurus/plugin-content-blog' {
   import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
   import type {MDXOptions} from '@docusaurus/mdx-loader';
-  import type {FrontMatterTag, Tag} from '@docusaurus/utils';
+  import type {
+    FrontMatterTag,
+    Tag,
+    LastUpdateData,
+    FrontMatterLastUpdate,
+  } from '@docusaurus/utils';
   import type {DocusaurusConfig, Plugin, LoadContext} from '@docusaurus/types';
   import type {Item as FeedItem} from 'feed';
   import type {Overwrite} from 'utility-types';
@@ -156,6 +161,8 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     toc_min_heading_level?: number;
     /** Maximum TOC heading level. Must be between 2 and 6. */
     toc_max_heading_level?: number;
+    /** Allows overriding the last updated author and/or date. */
+    last_update?: FrontMatterLastUpdate;
   };
 
   export type BlogPostFrontMatterAuthor = Author & {
@@ -180,7 +187,7 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     | BlogPostFrontMatterAuthor
     | (string | BlogPostFrontMatterAuthor)[];
 
-  export type BlogPostMetadata = {
+  export type BlogPostMetadata = LastUpdateData & {
     /** Path to the Markdown source, with `@site` alias. */
     readonly source: string;
     /**
@@ -426,6 +433,10 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     readingTime: ReadingTimeFunctionOption;
     /** Governs the direction of blog post sorting. */
     sortPosts: 'ascending' | 'descending';
+    /**	Whether to display the last date the doc was updated. */
+    showLastUpdateTime: boolean;
+    /** Whether to display the author who last updated the doc. */
+    showLastUpdateAuthor: boolean;
     /** An optional function which can be used to transform blog posts
      *  (filter, modify, delete, etc...).
      */