From cce1698c6063100c9ca5b724746804456fb74315 Mon Sep 17 00:00:00 2001 From: Emjek Cordover <556748+mjec@users.noreply.github.com> Date: Thu, 25 Jan 2024 07:19:55 -0500 Subject: [PATCH] docs: Note `showLastUpdateTime` requires complete checkout (#9784) --- website/docs/api/plugins/plugin-content-docs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/api/plugins/plugin-content-docs.mdx b/website/docs/api/plugins/plugin-content-docs.mdx index 7730d8fe46..36ad9f2149 100644 --- a/website/docs/api/plugins/plugin-content-docs.mdx +++ b/website/docs/api/plugins/plugin-content-docs.mdx @@ -58,7 +58,7 @@ Accepted fields: | `beforeDefaultRemarkPlugins` | `any[]` | `[]` | Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins. | | `beforeDefaultRehypePlugins` | `any[]` | `[]` | Custom Rehype plugins passed to MDX before the default Docusaurus Rehype plugins. | | `showLastUpdateAuthor` | `boolean` | `false` | Whether to display the author who last updated the doc. | -| `showLastUpdateTime` | `boolean` | `false` | Whether to display the last date the doc was updated. | +| `showLastUpdateTime` | `boolean` | `false` | Whether to display the last date the doc was updated. This requires access to git history during the build, so will not work correctly with shallow clones (a common default for CI systems). | | `breadcrumbs` | `boolean` | `true` | Enable or disable the breadcrumbs on doc pages. | | `disableVersioning` | `boolean` | `false` | Explicitly disable versioning even when multiple versions exist. This will make the site only include the current version. Will error if `includeCurrentVersion: false` and `disableVersioning: true`. | | `includeCurrentVersion` | `boolean` | `true` | Include the current version of your docs. |