关于 hugo-theme-github

https://github.com/hydrz/hugo-theme-github/actions/workflows/gh-pages.yml/badge.svg?branch=master https://img.shields.io/badge/Hugo-%5E0.62.0-ff4088?style=flat-square&logo=hugo https://img.shields.io/github/license/hydrz/hugo-theme-github?style=flat-square

 hugo-theme-github 是一个简洁、优雅且高效的 Hugo 博客主题。

它的原型基于 LoveIt 主题 and github-style 主题。

/about/preview.png
hugo-theme-github

主题预览

为了直观地浏览主题特性，这里有一个基于 hugo-theme-github 主题渲染的 预览网站。

特性

  • 自定义标题栏
  • 自定义CSS 样式
  • 焕然一新的主页，已经兼容最新版 Hugo
  • 大量的样式细节调整，包括颜色、字体大小、边距、代码预览样式
  • 可读性更强的深色模式
  • 一些美观的 CSS 动画
  • 易用和自动展开的文章目录
  • 支持更多的社交链接、网站分享和评论系统
  • 支持基于 Lunr.js 或 algolia 的搜索
  • 一键复制代码到剪贴板
  • 支持基于 Font Awesome 图标的扩展 Markdown 语法
  • 支持上标注释的扩展 Markdown 语法
  • 支持分数的扩展 Markdown 语法
  • 支持基于 KaTeX 的数学公式
  • 支持基于 mermaid 的图表生成功能
  • 支持基于 ECharts 的交互式数据可视化生成功能
  • 支持基于 Mapbox GL JS 的 Mapbox 地图显示功能
  • 支持基于 APlayer 和 MetingJS 的内嵌音乐播放器
  • 支持内嵌 Bilibili 视频
  • 支持多种注释的 shortcode
  • 支持自定义样式的 shortcode
  • 支持所有第三方库的 CDN
  • …

性能和 SEO

  • 性能优化：在 Google PageSpeed Insights 中， 99/100 的移动设备得分和 100/100 的桌面设备得分
  • 使用基于 JSON-LD 格式 的 SEO SCHEMA 文件进行 SEO 优化
  • 支持 Google Analytics
  • 支持 Fathom Analytics
  • 支持搜索引擎的网站验证 (Google, Bind, Yandex and Baidu)
  • 支持所有第三方库的 CDN
  • 基于 lazysizes 自动转换图片为懒加载

外观和布局

  • 响应式布局
  • 浅色/深色 主题模式
  • 全局一致的设计语言
  • 支持分页
  • 易用和自动展开的文章目录
  • 支持多语言和国际化
  • 美观的 CSS 动画

社交和评论系统

扩展功能

  • 支持基于 Lunr.js 或 algolia 的搜索
  • 支持 Twemoji
  • 支持代码高亮
  • 一键复制代码到剪贴板
  • 支持基于 lightgallery.js 的图片画廊
  • 支持 Font Awesome 图标的扩展 Markdown 语法
  • 支持上标注释的扩展 Markdown 语法
  • 支持分数的扩展 Markdown 语法
  • 支持基于 KaTeX 的数学公式
  • 支持基于 mermaid 的图表 shortcode
  • 支持基于 ECharts 的交互式数据可视化 shortcode
  • 支持基于 Mapbox GL JS 的 Mapbox shortcode
  • 支持基于 APlayer 和 MetingJS 的音乐播放器 shortcode
  • 支持 Bilibili 视频 shortcode
  • 支持多种注释的 shortcode
  • 支持自定义样式的 shortcode
  • 支持自定义脚本的 shortcode
  • 支持基于 TypeIt 的打字动画 shortcode
  • 支持基于 Smooth Scroll 的滚动动画
  • 支持基于 cookieconsent 的 Cookie 许可横幅
  • …

文档

在本地构建文档:

1
2
3
4
5
6

# 安装Hugo Pipes Babel依赖, see https://gohugo.io/hugo-pipes/babel/
npm install -g @babel/cli @babel/core
# 安装Github样式文件依赖， see https://primer.style/css/
npm install 
# Run hugo server
hugo server --source=exampleSite --themesDir ../.. -D --disableFastRender -e production

多语言和国际化

hugo-theme-github 支持下列语言:

  • 英语
  • 简体中文

许可协议

hugo-theme-github 根据 MIT 许可协议授权。 更多信息请查看 LICENSE 文件。

hugo-theme-github 主题中用到了以下项目，感谢它们的作者：