Skip to content

fix: grammar #4575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/guide/what-is-vitepress.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Just want to try it out? Skip to the [Quickstart](./getting-started).

- **Blogs, Portfolios, and Marketing Sites**

VitePress supports [fully customized themes](./custom-theme), with the developer experience of a standard Vite + Vue application. Being built on Vite also means you can directly leverage Vite plugins from its rich ecosystem. In addition, VitePress provides flexible APIs to [load data](./data-loading) (local or remote) and [dynamically generate routes](./routing#dynamic-routes). You can use it to build almost anything as long as the data can be determined at build time.
VitePress supports [fully customized themes](./custom-theme), with the developer experience of a standard Vite + Vue application. Being built on Vite also means you can directly leverage Vite plugins from its rich ecosystem. Additionally, VitePress provides flexible APIs to [load data](./data-loading) (local or remote) and [dynamically generate routes](./routing#dynamic-routes). You can use it to build almost anything as long as the data can be determined at build time.

The official [Vue.js blog](https://blog.vuejs.org/) is a simple blog that generates its index page based on local content.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## `vitepress dev`

Start VitePress dev server using designated directory as root. Defaults to current directory. The `dev` command can also be omitted when running in current directory.
Start a VitePress dev server using designated directory as root. Defaults to the current directory. The `dev` command can also be omitted when running in current directory.

### Usage

Expand Down Expand Up @@ -65,7 +65,7 @@ vitepress preview [root]

## `vitepress init`

Start the [Setup Wizard](../guide/getting-started#setup-wizard) in current directory.
Start the [Setup Wizard](../guide/getting-started#setup-wizard) in the current directory.

### Usage

Expand Down
8 changes: 4 additions & 4 deletions docs/en/reference/default-theme-badge.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Badge

The badge lets you add status to your headers. For example, it could be useful to specify the section's type, or supported version.
The badge lets you add status to your headers. For example, it could be useful to specify the section's type or supported version.

## Usage

Expand All @@ -13,7 +13,7 @@ You may use the `Badge` component which is globally available.
### Title <Badge type="danger" text="caution" />
```

Code above renders like:
The code above renders like:

### Title <Badge type="info" text="default" />
### Title <Badge type="tip" text="^1.9.0" />
Expand All @@ -22,7 +22,7 @@ Code above renders like:

## Custom Children

`<Badge>` accept `children`, which will be displayed in the badge.
`<Badge>` accepts `children`, which will be displayed in the badge.

```html
### Title <Badge type="info">custom element</Badge>
Expand Down Expand Up @@ -56,7 +56,7 @@ You can customize the style of badges by overriding css variables. The following

## `<Badge>`

`<Badge>` component accepts following props:
`<Badge>` component accepts the following props:

```ts
interface Props {
Expand Down
8 changes: 4 additions & 4 deletions docs/en/reference/default-theme-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type ThemeableImage =

- Type: `string | false`

You can customize this item to replace the default site title (`title` in app config) in nav. When set to `false`, title in nav will be disabled. Useful when you have `logo` that already contains the site title text.
You can customize this item to replace the default site title (`title` in app config) in nav. When set to `false`, title in nav will be disabled. Useful when you have a `logo` that already contains the site title text.

```ts
export default {
Expand Down Expand Up @@ -184,7 +184,7 @@ export type SidebarItem = {
- Default: `true`
- Can be overridden per page via [frontmatter](./frontmatter-config#aside)

Setting this value to `false` prevents rendering of aside container.\
Setting this value to `false` prevents rendering of the aside container.\
Setting this value to `true` renders the aside to the right.\
Setting this value to `left` renders the aside to the left.

Expand All @@ -195,7 +195,7 @@ If you want to disable it for all viewports, you should use `outline: false` ins
- Type: `Outline | Outline['level'] | false`
- Level can be overridden per page via [frontmatter](./frontmatter-config#outline)

Setting this value to `false` prevents rendering of outline container. Refer this interface for more details:
Setting this value to `false` prevents rendering of the outline container. Refer this interface for more details:

```ts
interface Outline {
Expand Down Expand Up @@ -283,7 +283,7 @@ export interface Footer {
- 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.
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.

```ts
export default {
Expand Down
4 changes: 2 additions & 2 deletions docs/en/reference/default-theme-edit-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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 {
Expand Down
6 changes: 3 additions & 3 deletions docs/en/reference/default-theme-footer.md
Original file line number Diff line number Diff line change
@@ -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 {
Expand All @@ -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 {
Expand All @@ -37,7 +37,7 @@ export default {
```

::: warning
Only inline elements can be used in `message` and `copyright` as they are rendered inside a `<p>` 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 `<p>` 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.
Expand Down
8 changes: 4 additions & 4 deletions docs/en/reference/default-theme-home-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ interface HeroAction {

### Customizing the name color

VitePress uses the brand color (`--vp-c-brand-1`) for the `name`. However, you may customize this color by overriding `--vp-home-hero-name-color` variable.
VitePress uses the brand color (`--vp-c-brand-1`) for the `name`. However, you may customize this color by overriding the `--vp-home-hero-name-color` variable.

```css
:root {
--vp-home-hero-name-color: blue;
}
```

Also you may customize it further by combining `--vp-home-hero-name-background` to give the `name` gradient color.
You may also customize it further by combining it with `--vp-home-hero-name-background` to give the `name` a gradient color.

```css
:root {
Expand All @@ -99,9 +99,9 @@ Also you may customize it further by combining `--vp-home-hero-name-background`

## Features Section

In Features section, you can list any number of features you would like to show right after the Hero section. To configure it, pass `features` option to the frontmatter.
In the Features section, you can list any number of features you would like to show right after the Hero section. To configure it, pass `features` option to the frontmatter.

You can provide an icon for each feature, which can be an emoji or any type of image. When the configured icon is an image (svg, png, jpeg...), you must provide the icon with the proper width and height; you can also provide the description, its intrinsic size as well as its variants for dark and light theme when required.
You can provide an icon for each feature, which can be an emoji or any type of image. When the configured icon is an image (svg, png, jpeg...), you must provide the icon with the proper width and height; you can also provide the description, its intrinsic size, as well as its variants for dark and light theme when required.

```yaml
---
Expand Down
4 changes: 2 additions & 2 deletions docs/en/reference/default-theme-last-updated.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.
14 changes: 7 additions & 7 deletions docs/en/reference/default-theme-layout.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Layout

You may choose the page layout by setting `layout` option to the page [frontmatter](./frontmatter-config). There are 3 layout options, `doc`, `page`, and `home`. If nothing is specified, then the page is treated as `doc` page.
You may choose the page layout by setting the `layout` option to the page [frontmatter](./frontmatter-config). There are 3 layout options, `doc`, `page`, and `home`. If nothing is specified, then the page is treated as a `doc` page.

```yaml
---
Expand All @@ -10,9 +10,9 @@ layout: doc

## Doc Layout

Option `doc` is the default layout and it styles the whole Markdown content into "documentation" look. It works by wrapping whole content within `vp-doc` css class, and applying styles to elements underneath it.
Option `doc` is the default layout and it styles all the Markdown content into a "documentation" look. It works by wrapping all the content within the `vp-doc` css class, and applying styles to elements underneath it.

Almost all generic elements such as `p`, or `h2` get special styling. Therefore, keep in mind that if you add any custom HTML inside a Markdown content, those will get affected by those styles as well.
Almost all generic elements such as `p`, or `h2` get special styling. Therefore, keep in mind that if you add any custom HTML inside Markdown content, those will get affected by those styles as well.

It also provides documentation specific features listed below. These features are only enabled in this layout.

Expand All @@ -23,15 +23,15 @@ It also provides documentation specific features listed below. These features ar

## Page Layout

Option `page` is treated as "blank page". The Markdown will still be parsed, and all of the [Markdown Extensions](../guide/markdown) work as same as `doc` layout, but it wouldn't get any default stylings.
Option `page` is treated as a "blank page". The Markdown will still be parsed, and all of the [Markdown Extensions](../guide/markdown) work the same as in a `doc` layout, but it wouldn't get any default stylings.

The page layout will let you style everything by you without VitePress theme affecting the markup. This is useful when you want to create your own custom page.
The page layout will let you style everything by yourself without the VitePress theme affecting the markup. This is useful when you want to create your own custom page.

Note that even in this layout, sidebar will still show up if the page has a matching sidebar config.
Note that even in this layout, a sidebar will still show up if the page has a matching sidebar config.

## Home Layout

Option `home` will generate templated "Homepage". In this layout, you can set extra options such as `hero` and `features` to customize the content further. Please visit [Default Theme: Home Page](./default-theme-home-page) for more details.
Option `home` will generate a templated "Homepage". In this layout, you can set extra options such as `hero` and `features` to customize the content further. Please visit [Default Theme: Home Page](./default-theme-home-page) for more details.

## No Layout

Expand Down
22 changes: 11 additions & 11 deletions docs/en/reference/default-theme-nav.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Nav is the navigation bar displayed on top of the page. It contains the site

## Site Title and Logo

By default, nav shows the title of the site referencing [`config.title`](./site-config#title) value. If you would like to change what's displayed on nav, you may define custom text in `themeConfig.siteTitle` option.
By default, nav shows the title of the site referencing the [`config.title`](./site-config#title) value. If you would like to change what's displayed on nav, you may define custom text in `themeConfig.siteTitle` option.

```js
export default {
Expand Down Expand Up @@ -35,11 +35,11 @@ export default {
}
```

You can also pass an object as logo if you want to add `alt` attribute or customize it based on dark/light mode. Refer [`themeConfig.logo`](./default-theme-config#logo) for details.
You can also pass an object as logo if you want to add `alt` attribute or customize it based on dark/light mode. Refer to [`themeConfig.logo`](./default-theme-config#logo) for details.

## Navigation Links

You may define `themeConfig.nav` option to add links to your nav.
You may define the `themeConfig.nav` option to add links to your nav.

```js
export default {
Expand All @@ -53,9 +53,9 @@ export default {
}
```

The `text` is the actual text displayed in nav, and the `link` is the link that will be navigated to when the text is clicked. For the link, set path to the actual file without `.md` prefix, and always start with `/`.
The `text` is the actual text displayed in nav, and the `link` is the link that will be navigated to when the text is clicked. For the link, set path to the actual file without the `.md` suffix, and always start with `/`.

Nav links can also be dropdown menus. To do this, set `items` key on link option.
Nav links can also be dropdown menus. To do this, set the `items` key on the link option.

```js
export default {
Expand All @@ -75,9 +75,9 @@ export default {
}
```

Note that dropdown menu title (`Dropdown Menu` in the above example) can not have `link` property since it becomes a button to open dropdown dialog.
Note that the dropdown menu title (`Dropdown Menu` in the above example) can not have a `link` property since it becomes a button to open dropdown dialog.

You may further add "sections" to the dropdown menu items as well by passing in more nested items.
You may add further "sections" to the dropdown menu items as well by passing in more nested items.

```js
export default {
Expand Down Expand Up @@ -116,7 +116,7 @@ export default {

### Customize link's "active" state

Nav menu items will be highlighted when the current page is under the matching path. if you would like to customize the path to be matched, define `activeMatch` property and regex as a string value.
Nav menu items will be highlighted when the current page is under the matching path. If you would like to customize the path to be matched, define the `activeMatch` property and regex as a string value.

```js
export default {
Expand All @@ -135,7 +135,7 @@ export default {
```

::: warning
`activeMatch` is expected to be a regex string, but you must define it as a string. We can't use actual RegExp object here because it isn't serializable during the build time.
`activeMatch` is expected to be a regex string, but you must define it as a string. We can't use an actual RegExp object here because it isn't serializable during the build time.
:::

### Customize link's "target" and "rel" attributes
Expand All @@ -159,7 +159,7 @@ export default {

## Social Links

Refer [`socialLinks`](./default-theme-config#sociallinks).
Refer to [`socialLinks`](./default-theme-config#sociallinks).

## Custom Components

Expand Down Expand Up @@ -209,6 +209,6 @@ export default {

Your component will be rendered in the navigation bar. VitePress will provide the following additional props to the component:

- `screenMenu`: an optional boolean indicating whether the component is inside mobile navigation menu
- `screenMenu`: an optional boolean indicating whether the component is inside the mobile navigation menu

You can check an example in the e2e tests [here](https://github.com/vuejs/vitepress/tree/main/__tests__/e2e/.vitepress).
6 changes: 3 additions & 3 deletions docs/en/reference/default-theme-prev-next-links.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
---
Expand All @@ -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
---
Expand Down
4 changes: 2 additions & 2 deletions docs/en/reference/default-theme-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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

Expand Down
Loading