跳到正文

内容组件

卡片

WCard 接受 title、subtitle、icon、image、link、footer,以及 horizontal 开关。WCardList 是网格容器:用 cols 控制列数。

内置

博客

从 /posts/ 收集文章,按日期排序并对列表分页。

本地

搜索

在本地索引每个页面,并随站点发布一个 worker。

Frontmatter

首页

Hero、actions 与特性网格都来自页面 frontmatter。
<WCardList :cols="3">
  <WCard title="博客" subtitle="内置">从 <code>/posts/</code> 收集文章。</WCard>
</WCardList>

带链接的卡片渲染为 router link:

步骤

WSteps 会给子项编号。start 可以改变起始编号,type 切换标记样式(default 或 simple)。

1

创建站点

执行 npm init vuepress,或给已有项目加上 VuePress。
2

安装主题

npm install vuepress-theme-github
3

配置

在 .vuepress/config.js 里把 githubTheme({ ... }) 作为主题传入。
4

写内容

添加 markdown 文件与 sidebar 配置。

徽章

Badge 接受 text 与 type(tip、info、warning、danger、success、 default),以及控制对齐的 vertical。

tipinfowarningdangersuccessdefault

友情链接

FriendLinks 渲染一个友链列表。把 items 传成 { name, link, desc, avatar } 数组, 或者用打勾清单写在 markdown 里再传进去。

作者卡片

WAuthor 渲染一个作者区块:头像、名称、一句话简介,以及一组联系方式。用在「关于」 页或文章末尾。

links 的每一项是 { name, link, icon? }。link 会按两种方式处理:

  • 绝对 URL(http:// / https://)→ 渲染成新窗口打开的外链
  • 其它值(例如 QQ 群号)→ 只作为文本展示,不会生成点不动的死链

icon 是可选的短标签,渲染在名称前面。

科技酱

科技酱

vuepress-theme-GitHub 的作者,折腾文档站与前端工具链。

想让整站页脚都显示作者与联系方式,改用主题选项 author(见 配置参考),不必逐页写组件。