Repo Card
Overview
The Repo Card component is used to display GitHub/Gitee repository information.
Usage
Components do not need to be registered; the theme will automatically import the RepoCard component on demand.
Simply use it directly in the markdown file:
<!-- use it in markdown -->
<RepoCard repo="pengzhanbo/vuepress-theme-plume" />Props
Repository address in owner/repo format
Repository platform. Currently only github/gitee are supported.
Whether to display the full repository name (owner/repo).
undefined(default): when the owner is an individual, onlyrepois shown; when the owner is an organization,owner/repois showntrue: always showowner/repofalse: always show onlyrepo(even when the owner is an organization, the full name is not shown)
Slots
This component provides no slots. Repository information is fetched internally through the GitHub / Gitee API and rendered for you; the content is fully determined by repo and provider.
To display custom content alongside repositories, build it with Card.
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:
