Add commit ID to the webpage footnote when updating the doc repo

[niconical]

Feature Request

Is your feature request related to a problem? Please describe:

The current web page document update footnote like:

Last updated on Jun 20, 2023 by Peefy

Describe the feature you'd like:
Is it easier to track document revisions by adding the commit ID of the document repo to the footnote when updating a webpage ?

Ref:

• https://kubernetes.io/docs/concepts/overview/

[shruti2522]

Hey @Peefy, can I take up this issue?

[Peefy]

@shruti2522 Sure, please.

[devc007]

"Hi @Peefy, this looks like a great and valuable contribution to the community. I’d love to work on this—could you please assign it to me?"

[devc007]

Hi,

I am trying to write a custom plugin that adds the last git commit hash to each doc page using the extendMarkdownPageData hook. My plugin is loaded (I see my logs), but the extendMarkdownPageData function is never called during the build, even though I have many markdown files in my docs folder.

Here’s a minimal version of my plugin:

// src/plugins/git-commit-info/index.js
const { exec } = require('child_process');

function getLastCommitHashAsync(filePath) {
  return new Promise((resolve) => {
    exec(`git log -n 1 --pretty=format:%h -- \"${filePath}\"`, { encoding: 'utf8' }, (err, stdout) => {
      if (err) return resolve(null);
      resolve(stdout.trim());
    });
  });
}

console.log('[git-commit-info] Plugin loaded');

module.exports = function (context, options) {
  return {
    name: 'docusaurus-plugin-git-commit-info',
    async extendMarkdownPageData(mdData) {
      console.log('[git-commit-info] mdData:', mdData);
      // ...rest of logic...
      return mdData;
    },
  };
};

And in my docusaurus.config.js I add it like this:

plugins: [
  require.resolve('./src/plugins/git-commit-info'),
  // other plugins...
],

But the hook is never triggered.

What I have tried so far:

I confirmed that my plugin is being loaded by adding [console.log('[git-commit-info] Plugin loaded');] at the top level, and I see this message during the build.
I added multiple [console.log] statements inside the [extendMarkdownPageData] function to check if it is ever called and to inspect the [mdData] object.
I verified that I have many markdown files in my [docs] directory, and they are referenced in my sidebar.
I tried running the build with different Docusaurus versions.
I also considered moving the plugin to remarkPlugins, but I understand this is not the correct approach for Docusaurus content plugins.
Despite these steps, the extendMarkdownPageData function is never called during the build.

My questions:
Is extendMarkdownPageData only called for plugins loaded as part of the docs content pipeline (e.g., via docs.plugins in docusaurus.config.js), and not for plugins in the main plugins array?
Should I add my plugin to the docs.plugins array instead?
Is there a recommended way to hook into the docs processing pipeline to add metadata to each doc page?
Is there anything else I might be missing?
Thank you for your help!

[Peefy]

Thank you! Just Open PRs