Skip to content

Commit ffd0def

Browse files
XaviTorelloulivz
authored andcommitted
docs: extend Hero example with core properties (#1088)
It improves the example to describe with an example the following metas: - heroText - tagline
1 parent 04510e9 commit ffd0def

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

packages/docs/docs/theme/default-theme-config.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@ All options listed on this page apply to the default theme only. If you are usin
88

99
## Homepage
1010

11-
The default theme provides a homepage layout (which is used on [the homepage of this very website](../README.md)). To use it, specify `home: true` plus some other metadata in your root `README.md`'s [YAML front matter](../guide/markdown.md#front-matter). This is the actual data used on this site:
11+
The default theme provides a homepage layout (which is used on [the homepage of this very website](../README.md)). To use it, specify `home: true` plus some other metadata in your root `README.md`'s [YAML front matter](../guide/markdown.md#front-matter). This is an example of how it works:
1212

1313
``` yaml
1414
---
1515
home: true
1616
heroImage: /hero.png
17+
heroText: Hero Title
18+
tagline: Hero subtitle
1719
actionText: Get Started →
1820
actionLink: /guide/
1921
features:

0 commit comments

Comments
 (0)