diff --git a/docs/reference/default-theme-config.md b/docs/reference/default-theme-config.md index f196c626..a35aec2c 100644 --- a/docs/reference/default-theme-config.md +++ b/docs/reference/default-theme-config.md @@ -265,6 +265,7 @@ export interface Footer { ## editLink - Type: `EditLink` +- Can be overridden per page via [frontmatter](./frontmatter-config#editlink) Edit Link lets you display a link to edit the page on Git management services such as GitHub, or GitLab. See [Default Theme: Edit Link](./default-theme-edit-link) for more details. diff --git a/docs/reference/default-theme-edit-link.md b/docs/reference/default-theme-edit-link.md index 7f068f29..c52adf4e 100644 --- a/docs/reference/default-theme-edit-link.md +++ b/docs/reference/default-theme-edit-link.md @@ -1,5 +1,7 @@ # Edit Link +## Site-Level Config + Edit Link lets you display a link to edit the page on Git management services such as GitHub, or GitLab. To enable it, add `themeConfig.editLink` options to your config. ```js @@ -46,3 +48,13 @@ export default { } } ``` + +## Frontmatter Config + +This can be disabled per-page using the `editLink` option on frontmatter: + +```yaml +--- +lastUpdated: false +--- +``` diff --git a/docs/reference/default-theme-last-updated.md b/docs/reference/default-theme-last-updated.md index b9058a90..e2cbb1d2 100644 --- a/docs/reference/default-theme-last-updated.md +++ b/docs/reference/default-theme-last-updated.md @@ -1,11 +1,8 @@ # Last Updated -The update time of the last content will be displayed in the lower right corner of the page. -To enable it, add `lastUpdated` options to your config. +The update time of the last content will be displayed in the lower right corner of the page. To enable it, add `lastUpdated` options to your config. -## Page Configuration - -Add `lastUpdated` options to your config. +## Site-Level Config ```js export default { @@ -13,9 +10,9 @@ export default { } ``` -## Frontmatter Configuration +## Frontmatter Config -If you would like to hide the last update text, set false to the `lastUpdated` option. +This can be disabled per-page using the `lastUpdated` option on frontmatter: ```yaml --- diff --git a/docs/reference/frontmatter-config.md b/docs/reference/frontmatter-config.md index e77e00cc..4322d985 100644 --- a/docs/reference/frontmatter-config.md +++ b/docs/reference/frontmatter-config.md @@ -136,10 +136,23 @@ The levels of header in the outline to display for the page. It's same as [confi - Type: `boolean` - Default: `true` -Whether to display [Last Updated](./default-theme-last-updated) text in the current page. +Whether to display [Last Updated](./default-theme-last-updated) text in the footer of the current page. ```yaml --- lastUpdated: false --- ``` + +### editLink + +- Type: `boolean` +- Default: `true` + +Whether to display [Edit Link](./default-theme-edit-link) in the footer of the current page. + +```yaml +--- +editLink: false +--- +```