跳到正文

vuepress-theme-GitHub

看起来像一个仓库的文档站

一个完全独立实现的 VuePress 2 主题,整站由 GitHub Primer token 构建。

看起来像一个仓库的文档站

为什么还要一个 GitHub 主题?

因为这个主题是独立的。它不继承 @vuepress/theme-default,因此不会带上那个主题的 sass-palette 弃用告警,也不会遇到它在 rc 之间漂移的 API。整套布局都由本包自己拥有。

npm install vuepress-theme-github

想安装就前往指南,或直接跳到配置参考。

作者

科技酱

科技酱

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

仓库外观

吸顶头部、文件树侧边栏、Readme 排版与右侧页内目录,全部取自 GitHub Primer。

文档站

多级侧边栏、右侧页内目录、上一页/下一页、本地全文搜索。

内置博客

从 /posts/ 收集文章,按日期倒序,自带标签页、归档与分页。

Frontmatter 首页

Hero、actions 与特性网格完全由 frontmatter 驱动。

组件库

卡片、步骤、徽章、提示块与友链,全局注册,markdown 直接可用。

独立架构

不依赖默认主题。运行时只有 vuepress、Vite bundler 与 sass。