Skip to content

Latest commit

 

History

History
150 lines (124 loc) · 7.4 KB

README.md

File metadata and controls

150 lines (124 loc) · 7.4 KB

hugo-theme-github github pages

Hugo License

English README | 简体中文说明

hugo-theme-github is a clean, elegant but advanced blog theme for Hugo.

It is based on the original LoveIt Theme and github-style Theme.

hugo-theme-github

Demo Site

To see this theme in action, here is a live demo site which is rendered with hugo-theme-github theme.

Features

  • Custom Header
  • Custom CSS Style
  • A new home page, compatible with the latest version of Hugo
  • A lot of style detail adjustments, including color, font size, margins, code preview style
  • More readable dark mode
  • Some beautiful CSS animations
  • Easy-to-use and self-expanding table of contents
  • More social links, share sites and comment system
  • Search supported by Lunr.js or algolia
  • Copy code to clipboard with one click
  • Extended Markdown syntax for Font Awesome icons
  • Extended Markdown syntax for ruby annotation
  • Extended Markdown syntax for fraction
  • Mathematical formula supported by KaTeX
  • Diagram syntax shortcode supported by mermaid
  • Interactive data visualization shortcode supported by ECharts
  • Mapbox shortcode supported by Mapbox GL JS
  • Embedded music player supported by APlayer and MetingJS
  • Bilibili player supported
  • Kinds of admonitions shortcode supported
  • Custom style shortcodes supported
  • CDN for all third-party libraries supported
  • ...

Performance and SEO

  • Optimized for performance: 99/100 on mobile and 100/100 on desktop in Google PageSpeed Insights
  • Optimized SEO performance with a correct SEO SCHEMA based on JSON-LD
  • Google Analytics supported
  • Fathom Analytics supported
  • Search engine verification supported (Google, Bind, Yandex and Baidu)
  • CDN for third-party libraries supported
  • Automatically converted images with Lazy Load by lazysizes

Appearance and Layout

  • Responsive layout
  • Light/Dark mode
  • Globally consistent design language
  • Pagination supported
  • Easy-to-use and self-expanding table of contents
  • Multilanguage supported and i18n ready
  • Beautiful CSS animation

Social and Comment Systems

  • Gravatar supported by Gravatar
  • Local Avatar supported
  • Up to 64 social links supported
  • Up to 28 share sites supported
  • Disqus comment system supported by Disqus
  • Gitalk comment system supported by Gitalk
  • Valine comment system supported by Valine
  • Facebook comments system supported by Facebook
  • Telegram comments system supported by Telegram Comments
  • Commento comment system supported by Commento
  • Utterances comment system supported by Utterances

Extended Features

  • Search supported by Lunr.js or algolia
  • Twemoji supported
  • Automatically highlighting code
  • Copy code to clipboard with one click
  • Images gallery supported by lightgallery.js
  • Extended Markdown syntax for Font Awesome icons
  • Extended Markdown syntax for ruby annotation
  • Extended Markdown syntax for fraction
  • Mathematical formula supported by KaTeX
  • Diagrams shortcode supported by mermaid
  • Interactive data visualization shortcode supported by ECharts
  • Mapbox shortcode supported by Mapbox GL JS
  • Music player shortcode supported by APlayer and MetingJS
  • Bilibili player shortcode
  • Kinds of admonitions shortcode
  • Custom style shortcode
  • Custom script shortcode
  • Animated typing supported by TypeIt
  • Dynamic scroll supported by Smooth Scroll
  • Cookie consent banner supported by cookieconsent
  • ...

Documentation

Build Documentation Locally:

# For Hugo Pipes to process JS files with Babel, see https://gohugo.io/hugo-pipes/babel/
npm install -g @babel/cli @babel/core
# For import github style sass file, see https://primer.style/css/
npm install 
# Run hugo server
hugo server --source=exampleSite --themesDir ../.. -D --disableFastRender -e production

Multilingual and i18n

hugo-theme-github supports the following languages:

  • English
  • Simplified Chinese

License

hugo-theme-github is licensed under the MIT license. Check the LICENSE file for details.

Thanks to the authors of following resources included in the theme: