From 09030272b4a5c8f723b7e11303265f24b7481575 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Sat, 17 Feb 2024 13:40:23 -0600 Subject: [PATCH] feat(theme): auto style markdown content in home page (#3561) BREAKING CHANGES: styles are now applied by default to markdown content when `layout: home` is set in frontmatter. If they conflict with the styles of your custom component, please set `markdownStyles: false` in frontmatter. --------- Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> --- docs/reference/default-theme-home-page.md | 27 ++++++++++ .../theme-default/components/VPHome.vue | 18 ++++--- .../components/VPHomeContent.vue | 52 +++++++++++++++++++ .../components/VPHomeSponsors.vue | 29 ++++++++++- .../theme-default/components/VPTeamPage.vue | 9 +++- .../styles/components/vp-doc.css | 4 ++ .../styles/components/vp-sponsor.css | 4 +- 7 files changed, 129 insertions(+), 14 deletions(-) create mode 100644 src/client/theme-default/components/VPHomeContent.vue diff --git a/docs/reference/default-theme-home-page.md b/docs/reference/default-theme-home-page.md index b44c2e6b79bb..f7baecca0138 100644 --- a/docs/reference/default-theme-home-page.md +++ b/docs/reference/default-theme-home-page.md @@ -166,3 +166,30 @@ type FeatureIcon = height: string } ``` + +## Markdown Content + +You can add additional content to your site's homepage just by adding Markdown below the `---` frontmatter divider. + +````md +--- +layout: home + +hero: + name: VitePress + text: Vite & Vue powered static site generator. +--- + +## Getting Started + +You can get started using VitePress right away using `npx`! + +```sh +npm init +npx vitepress init +``` +```` + +::: info +VitePress didn't always auto-style the extra content of the `layout: home` page. To revert to older behavior, you can add `markdownStyles: false` to the frontmatter. +::: diff --git a/src/client/theme-default/components/VPHome.vue b/src/client/theme-default/components/VPHome.vue index d69a79b21a73..445ff3162ad8 100644 --- a/src/client/theme-default/components/VPHome.vue +++ b/src/client/theme-default/components/VPHome.vue @@ -1,6 +1,10 @@ diff --git a/src/client/theme-default/components/VPHomeContent.vue b/src/client/theme-default/components/VPHomeContent.vue new file mode 100644 index 000000000000..fe689b6ee5ef --- /dev/null +++ b/src/client/theme-default/components/VPHomeContent.vue @@ -0,0 +1,52 @@ + + + + + diff --git a/src/client/theme-default/components/VPHomeSponsors.vue b/src/client/theme-default/components/VPHomeSponsors.vue index 44878a949345..1343e776104b 100644 --- a/src/client/theme-default/components/VPHomeSponsors.vue +++ b/src/client/theme-default/components/VPHomeSponsors.vue @@ -49,8 +49,33 @@ withDefaults(defineProps(), {