Skip to content
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

docs: grammar/Readability Improvements for English Documentation #4060

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
615e4b5
Minor SPAG edits
PolarisWasInDenial Jul 18, 2024
b956b66
Update cms.md
PolarisWasInDenial Jul 18, 2024
1b14484
Update custom-theme.md
PolarisWasInDenial Jul 18, 2024
f30c4a2
Update data-loading.md
PolarisWasInDenial Jul 18, 2024
7f5c216
Update deploy.md
PolarisWasInDenial Jul 18, 2024
ad20539
Update extending-default-theme.md
PolarisWasInDenial Jul 18, 2024
87577d7
Update frontmatter.md
PolarisWasInDenial Jul 18, 2024
49602b8
Update i18n.md
PolarisWasInDenial Jul 18, 2024
ab19cde
Update markdown.md
PolarisWasInDenial Jul 18, 2024
a73fe0b
Update migration-from-vitepress-0.md
PolarisWasInDenial Jul 18, 2024
e8df271
Update migration-from-vuepress.md
PolarisWasInDenial Jul 18, 2024
9868970
Update mpa-mode.md
PolarisWasInDenial Jul 18, 2024
17e122a
Update routing.md
PolarisWasInDenial Jul 18, 2024
1109c0e
Update ssr-compat.md
PolarisWasInDenial Jul 18, 2024
878e45a
Update using-vue.md
PolarisWasInDenial Jul 18, 2024
28f98ee
Update what-is-vitepress.md
PolarisWasInDenial Jul 18, 2024
09590f9
Update cli.md
PolarisWasInDenial Jul 18, 2024
176e9cd
Update default-theme-badge.md
PolarisWasInDenial Jul 18, 2024
5185fc8
Update default-theme-carbon-ads.md
PolarisWasInDenial Jul 18, 2024
eef6994
Update default-theme-config.md
PolarisWasInDenial Jul 18, 2024
d48c55a
Update default-theme-edit-link.md
PolarisWasInDenial Jul 18, 2024
9a24107
Update default-theme-footer.md
PolarisWasInDenial Jul 18, 2024
5430a9b
Update default-theme-home-page.md
PolarisWasInDenial Jul 18, 2024
3f4c23c
Update default-theme-last-updated.md
PolarisWasInDenial Jul 18, 2024
3f7242b
Update default-theme-layout.md
PolarisWasInDenial Jul 18, 2024
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
Prev Previous commit
Next Next commit
Update default-theme-home-page.md
  • Loading branch information
PolarisWasInDenial authored Jul 18, 2024
commit 5430a9bdc5cafb152e23c008db015024ef685e17
16 changes: 8 additions & 8 deletions docs/en/reference/default-theme-home-page.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Home Page

VitePress default theme provides a homepage layout, which you can also see used on [the homepage of this site](../). You may use it on any of your pages by specifying `layout: home` in the [frontmatter](./frontmatter-config).
VitePress' default theme provides a homepage layout, which you can also see used on [the homepage of this site](../). You may use it on any of your pages by specifying `layout: home` in the [frontmatter](./frontmatter-config).

```yaml
---
layout: home
---
```

However, this option alone wouldn't do much. You can add several different pre templated "sections" to the homepage by setting additional other options such as `hero` and `features`.
However, this option alone wouldn't do much. You can add several different pre-made template "sections" to the homepage by setting additional other options such as `hero` and `features`.

## Hero Section

Expand Down Expand Up @@ -37,8 +37,8 @@ hero:

```ts
interface Hero {
// The string shown top of `text`. Comes with brand color
// and expected to be short, such as product name.
// The string shown top of `text`. Comes with the brand color
// and expected to be short, such as a product name.
name?: string

// The main text for the hero section. This will be defined
Expand All @@ -51,7 +51,7 @@ interface Hero {
// The image is displayed next to the text and tagline area.
image?: ThemeableImage

// Action buttons to display in home hero section.
// Action buttons to display in the home hero section.
actions?: HeroAction[]
}

Expand Down Expand Up @@ -88,7 +88,7 @@ VitePress uses the brand color (`--vp-c-brand-1`) for the `name`. However, you m
}
```

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 `--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 the `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 themes when required.

```yaml
---
Expand Down