ppoffice/hexo-theme-icarus

A simple, delicate, and modern theme for the static site generator Hexo.
Preview · Documentation · Discussions · 简体中文

Quick Start

For a published install, in the root directory of a Hexo site compatible with ^7.1.1 || ^8.0.0:

npm install hexo-theme-icarus hexo-renderer-inferno
hexo config theme icarus
hexo server

Icarus creates _config.icarus.yml, with every option described, on the first run. See Getting Started for requirements, source installs, and the distinction between published packages and the current development checkout.

Three Variants

One line in _config.icarus.yml, or in the front-matter of a single post, switches the whole look.

Default · variant: default The classic Icarus look in light, dark, or appearance: auto, which follows each visitor's system and adds a light/dark switch to the navbar. Demo

Cyberpunk · variant: cyberpunk Always dark: neon colors, HUD panels with chamfered corners, scanlines, and its own code palette. Demo

Material 3 Expressive · variant: m3e Tinted surfaces, rounded cards, and pill-shaped controls that change shape on hover and keyboard focus, with light and dark schemes. Demo

Highlights

Responsive One to three columns, navbar sub-menus that fold into a menu button, an optional sticky navbar, and a mobile table of contents.

Configure per page Set options site-wide, override them per layout in _config.post.yml, or per post in its front-matter.

50+ plugins built in Comments, search, sharing, donations, analytics and widgets, ready to switch on in the config.

Also built in:

• Fast navigation: PJAX page loading with scroll restoration on Back/Forward, and page prefetching on hover.
• Reading: a reading progress bar, folded code blocks with a preview, and a notice on posts that have not been updated for a long time.
• Math and images: KaTeX or MathJax 4, and lightGallery 3 with Justified Gallery.
• Privacy: in opt-in mode, Cookie Consent loads the built-in analytics only after visitors allow them; Web Share shares without a third-party SDK.
• Accessible: keyboard navigation, screen reader labels, / or Ctrl+K to search, and translations into 17 languages.

Supported integrations

Type	Integrations
Comment	Artalk, Beaudar, Changyan, Disqus, DisqusJS, Giscus, Gitalk 2 (preview), Isso, LiveRe, Twikoo, Utterances, Waline
Search	Algolia, Baidu, Google CSE, Insight (built-in)
Share	AddToAny, ShareThis, Web Share
Donate	Afdian, Alipay, Buy Me a Coffee, Patreon, PayPal, WeChat Pay
Analytics	Baidu Statistics, Bing Webmaster, BuSuanZi, CNZZ (Umeng+), Google Analytics, Hotjar, Matomo, StatCounter, X (Twitter) Conversion Tracking, Umami, Waline page views
Widgets	Profile, Table of Contents, Recent Posts, Archives, Categories, Tags, GitHub Contributions, Links, Google AdSense, follow.it
Others	Back to Top, Cookie Consent, Gallery (lightGallery + Justified Gallery), KaTeX, MathJax 4, Browser Capability Notice, Page Loading Animations, PJAX, Page Prefetching, Progress Bar

Most integrations are provided by hexo-component-inferno.

Documentation

Getting Started · Configuring the Theme · Upgrade Guide · FAQ · Demos · All Guides

Contributing

Bug reports, feature ideas, translations and tutorials are all welcome. Open an issue or a pull request.

Icarus is built with Hexo, Inferno, Stylus and Bulma. To work on it:

npm ci
npm run lint
npm test            # unit and integration tests
npm run test:e2e    # browser tests; run "npx playwright install chromium" once first

The tests need Node.js 20.19 or later. See the contributing guide for code style and commit conventions.

License

MIT