From 77239ffd52b08bfb38848e696e87465d8f04f23f Mon Sep 17 00:00:00 2001 From: ruben Date: Sat, 22 Feb 2025 20:09:28 -0800 Subject: [PATCH 01/16] fix: address grammar issues in footer reference page --- docs/en/reference/default-theme-footer.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/reference/default-theme-footer.md b/docs/en/reference/default-theme-footer.md index a58e8ac6b198..18ceab5f67c8 100644 --- a/docs/en/reference/default-theme-footer.md +++ b/docs/en/reference/default-theme-footer.md @@ -1,6 +1,6 @@ # Footer -VitePress will display global footer at the bottom of the page when `themeConfig.footer` is present. +VitePress will display the global footer at the bottom of the page when `themeConfig.footer` is present. ```ts export default { @@ -23,7 +23,7 @@ export interface Footer { } ``` -The above configuration also supports HTML strings. So, for example, if you want to configure footer text to have some links, you can adjust the configuration as follows: +The above configuration also supports HTML strings. For example, if you want to configure the footer text to have some links, you can adjust the configuration as follows: ```ts export default { @@ -37,7 +37,7 @@ export default { ``` ::: warning -Only inline elements can be used in `message` and `copyright` as they are rendered inside a `

` element. If you want to add block elements, consider using [`layout-bottom`](../guide/extending-default-theme#layout-slots) slot instead. +Only inline elements can be used in `message` and `copyright` as they are rendered inside a `

` element. If you want to add block elements, consider using the [`layout-bottom`](../guide/extending-default-theme#layout-slots) slot instead. ::: Note that footer will not be displayed when the [SideBar](./default-theme-sidebar) is visible. From 73f5d563b7eaa0152b6cf4e7f293d583edb6a40d Mon Sep 17 00:00:00 2001 From: ruben Date: Sat, 22 Feb 2025 20:15:00 -0800 Subject: [PATCH 02/16] fix: correct grammar in search reference page --- docs/en/reference/default-theme-search.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/reference/default-theme-search.md b/docs/en/reference/default-theme-search.md index d647e32ed252..f00c18e0bdde 100644 --- a/docs/en/reference/default-theme-search.md +++ b/docs/en/reference/default-theme-search.md @@ -6,7 +6,7 @@ outline: deep ## Local Search -VitePress supports fuzzy full-text search using a in-browser index thanks to [minisearch](https://github.com/lucaong/minisearch/). To enable this feature, simply set the `themeConfig.search.provider` option to `'local'` in your `.vitepress/config.ts` file: +VitePress supports fuzzy full-text search using an in-browser index thanks to [minisearch](https://github.com/lucaong/minisearch/). To enable this feature, simply set the `themeConfig.search.provider` option to `'local'` in your `.vitepress/config.ts` file: ```ts import { defineConfig } from 'vitepress' @@ -272,7 +272,7 @@ export default defineConfig({ }) ``` -[These options](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts) can be overridden. Refer official Algolia docs to learn more about them. +[These options](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts) can be overridden. Refer to the official Algolia docs to learn more about them. ### Crawler Config From deaa3f366934c0d13422da54e5f96a0eb6397750 Mon Sep 17 00:00:00 2001 From: ruben Date: Sat, 22 Feb 2025 20:17:33 -0800 Subject: [PATCH 03/16] fix: clarify sentence in last-updated reference page --- docs/en/reference/default-theme-last-updated.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/reference/default-theme-last-updated.md b/docs/en/reference/default-theme-last-updated.md index 00fed72a08e8..6a3c2240a5c9 100644 --- a/docs/en/reference/default-theme-last-updated.md +++ b/docs/en/reference/default-theme-last-updated.md @@ -1,6 +1,6 @@ # 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 last updated time of the content will be displayed in the lower right corner of the page. To enable it, add the `lastUpdated` option to your config. ::: tip You need to commit the markdown file to see the updated time. @@ -24,4 +24,4 @@ lastUpdated: false --- ``` -Also refer [Default Theme: Last Updated](./default-theme-config#lastupdated) for more details. Any truthy value at theme-level will also enable the feature unless explicitly disabled at site or page level. +Also refer to [Default Theme: Last Updated](./default-theme-config#lastupdated) for more details. Any truthy value at theme-level will also enable the feature unless explicitly disabled at site or page level. From 04e6ba536c0883391483125f64ba462fd1263487 Mon Sep 17 00:00:00 2001 From: ruben Date: Sat, 22 Feb 2025 20:20:32 -0800 Subject: [PATCH 04/16] fix: remove unnecessary comma and clarify text --- docs/en/reference/default-theme-edit-link.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/reference/default-theme-edit-link.md b/docs/en/reference/default-theme-edit-link.md index ff049d59e3a9..63ba5403a26b 100644 --- a/docs/en/reference/default-theme-edit-link.md +++ b/docs/en/reference/default-theme-edit-link.md @@ -2,7 +2,7 @@ ## 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. +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 export default { @@ -36,7 +36,7 @@ export default { It should not have side-effects nor access anything outside of its scope since it will be serialized and executed in the browser. -By default, this will add the link text "Edit this page" at the bottom of the doc page. You may customize this text by defining the `text` option. +By default, this will add the hyperlinked text "Edit this page" at the bottom of the doc page. You may customize this text by defining the `text` option. ```js export default { From e297e70c2e8c806a52e4d1d0622456ef04c69baf Mon Sep 17 00:00:00 2001 From: ruben Date: Sat, 22 Feb 2025 20:22:02 -0800 Subject: [PATCH 05/16] fix: add word 'the' where appropriate in prev-next-links reference page --- docs/en/reference/default-theme-prev-next-links.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/reference/default-theme-prev-next-links.md b/docs/en/reference/default-theme-prev-next-links.md index 7befe179b5bc..d67fcd3649ea 100644 --- a/docs/en/reference/default-theme-prev-next-links.md +++ b/docs/en/reference/default-theme-prev-next-links.md @@ -1,6 +1,6 @@ # Prev Next Links -You can customize the text and link for the previous and next pages (shown at doc footer). This is helpful if you want a different text there than what you have on your sidebar. Additionally, you may find it useful to disable the footer or link to a page that is not included in your sidebar. +You can customize the text and link for the previous and next pages (shown at the doc footer). This is helpful if you want a different text there than what you have on your sidebar. Additionally, you may find it useful to disable the footer or link to a page that is not included in your sidebar. ## prev @@ -20,7 +20,7 @@ You can customize the text and link for the previous and next pages (shown at do --- ``` - - To customize both text and link: + - To customize both the text and link: ```yaml --- @@ -30,7 +30,7 @@ You can customize the text and link for the previous and next pages (shown at do --- ``` - - To hide previous page: + - To hide the previous page: ```yaml --- From 9524c3051f691ae29a18125e8a2f3895c12b9b8e Mon Sep 17 00:00:00 2001 From: ruben Date: Sat, 22 Feb 2025 20:29:27 -0800 Subject: [PATCH 06/16] fix: correct a variety of issues inside team-page reference --- docs/en/reference/default-theme-team-page.md | 28 ++++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/en/reference/default-theme-team-page.md b/docs/en/reference/default-theme-team-page.md index 29b071ff82b9..4a48512da47c 100644 --- a/docs/en/reference/default-theme-team-page.md +++ b/docs/en/reference/default-theme-team-page.md @@ -25,11 +25,11 @@ const members = [ # Team Page -If you would like to introduce your team, you may use Team components to construct the Team Page. There are two ways of using these components. One is to embed it in doc page, and another is to create a full Team Page. +If you would like to introduce your team, you may use Team components to construct the Team Page. There are two ways of using these components. One is to embed it in a doc page, and another is to create a full Team Page. ## Show team members in a page -You may use `` component exposed from `vitepress/theme` to display a list of team members on any page. +You may use the `` component exposed from `vitepress/theme` to display a list of team members on any page. ```html