Built-in Components

By using vuepress-plugin-components, you can import and use some components in your Markdown files.

Available components:

• Badge: Colorful badge component
• CodePen: Embedded CodePen demo
• Share: Sharing current page with social medias
• StackBlitz: Embedded StackBlitz demo
• SiteInfo: Display sites
• VPBanner: A banner component
• VPCard: A card component

To enable components, you should set plugins.components.components with an array of components names.

Tips

Media components are provided by @vuepress/plugin-media, which are enabled via plugins.media.

Note

By default, <Badge /> is available to align with @vuepress/theme-default.

.vuepress/theme.ts

import { 
hopeTheme
 } from "vuepress-theme-hope";

export default 
hopeTheme
({
  
plugins
: {
    
components
: {
      // components you want
      
components
: [
        "Badge",
        "CodePen",
        "Share",
        "SiteInfo",
        "StackBlitz",
        "VPBanner",
        "VPCard",
      ],
    },
  },
});

Utilities

Badge

• tip
• warning
• danger
• important
• info
• note

Badge types

- <Badge text="tip" type="tip" vertical="middle" />
- <Badge text="warning" type="warning" vertical="middle" />
- <Badge text="danger" type="danger" vertical="middle" />
- <Badge text="important" type="important" vertical="middle" />
- <Badge text="info" type="info" vertical="middle" />
- <Badge text="note" type="note" vertical="middle" />

See Badge page for available props.

SiteInfo

Mr.Hope's Blog

Basic site info

<SiteInfo name="Mr.Hope's Blog" url="https://mister-hope.com" preview="https://theme-hope.vuejs.press/assets/image/mrhope.jpg" />

Mr.Hope's Blog

Where there is light, there is hope

Site info with more properties

<SiteInfo
  name="Mr.Hope's Blog"
  desc="Where there is light, there is hope"
  url="https://mister-hope.com"
  logo="https://mister-hope.com/logo.svg"
  repo="https://github.com/Mister-Hope/Mister-Hope.github.io"
  preview="https://theme-hope.vuejs.press/assets/image/mrhope.jpg"
/>

See SiteInfo page for available props.

Share

Basic share

<Share />

Customize services

<Share services="qq,weibo" />
<Share :services="['qq','weibo']" />

Colorful icon

<Share colorful />

See Share page for available props.

Code

CodePen

A component which allows you to embed CodePen demo.

See Solar System animation - Pure CSS by kowlor on CodePen.

A demo with user and slug hash

<CodePen
  user="kowlor"
  slug-hash="ZYYQoy"
  title="Solar System animation - Pure CSS"
  :default-tab="['css','result']"
  :theme="$isDarkMode? 'dark': 'light'"
/>

See Solar System animation - Pure CSS by kowlor on CodePen.

A demo with link

<CodePen
  link="https://codepen.io/kowlor/pen/ZYYQoy"
  title="Solar System animation - Pure CSS"
  :default-tab="['css','result']"
  :theme="$isDarkMode? 'dark': 'light'"
/>

See Envelope w/ Hearts by kowlor on CodePen.

A click to run demo

<CodePen
  link="https://codepen.io/kowlor/pen/ZYYQoy"
  title="Envelope w/ Hearts"
  status="clicktorun"
  :default-tab="['css','result']"
  :theme="$isDarkMode? 'dark': 'light'"
/>

See CodePen page for available props.

StackBlitz

Embed StackBlitz demo in Markdown files.

A StackBlitz project

<StackBlitz id="vuepress-theme-hope" />

A StackBlitz project with custom settings

<StackBlitz id="vuepress-theme-hope" hideExplorer hideNavigation hideDevtools />

See StackBlitz page for available props.