Overview

The Repo Card component is used to display GitHub/Gitee repository information.

Usage

To use this component, you need to manually import the RepoCard component:

<!-- Import in markdown -->
<script setup>
import RepoCard from 'vuepress-theme-plume/features/RepoCard.vue'
</script>

<!-- After importing, you can use it in markdown -->
<RepoCard repo="pengzhanbo/vuepress-theme-plume" />

Register as a global component:

.vuepress/client.ts

import RepoCard from 'vuepress-theme-plume/features/RepoCard.vue'
import { defineClientConfig } from 'vuepress/client'

export default defineClientConfig({
  enhance({ app }) {
    app.component('RepoCard', RepoCard)
  },
})

Global components can be used in any other markdown file:

<RepoCard repo="pengzhanbo/vuepress-theme-plume" />

Props

repoRequiredstring

Repository address in owner/repo format

providerOptionalgithub | gitee

'github'

Repository platform. Currently only github/gitee are supported.

fullnameOptionalboolean

Whether to display the full repository name.

The full repository name is owner/repo.

• If the owner is an individual, the full repository name is not displayed by default, only repo is shown.
• If the owner is an organization, the full repository name is displayed by default.

Examples

Single Card

Input:

<RepoCard repo="pengzhanbo/vuepress-theme-plume" />

Output:

Multiple Cards

If you want to display multiple cards side by side in a compact way, you can use the CardGrid component.

Input:

<CardGrid>
  <RepoCard repo="vuepress/core" />
  <RepoCard repo="vuepress/ecosystem" />
</CardGrid>

Output:

Input:

<CardGrid>
  <RepoCard repo="pengzb/vuepress-theme-plume" provider="gitee" />
  <RepoCard repo="pengzb/vite-plugin-mock-dev-server" provider="gitee" />
</CardGrid>

Output:

Contributors

pengzhanbo

Changelog

10/9/25, 7:46 AM

View All Changelog

• 38505-docs: update en docs (#708)on 10/9/25
• 4d236-feat(theme)!: add collections support (#704)on 10/7/25
• 94e75-feat(theme): add gitee provider support for repocard, close #674 (#675)on 8/19/25
• 49d84-feat(theme): add fullname prop support for RepoCard, close #669 (#670)on 8/19/25
• d1496-docs: update docson 4/30/25
• 0fd6c-refactor(theme): improve types and flat config (#524)on 3/15/25
• 597a1-style: lint fixon 11/29/24
• e3b1c-docs: improve docson 8/18/24
• ac898-docs: update docson 7/27/24