Skip to content

Repository files navigation

ZhiMo

A paper-and-ink, multilingual Hexo theme for long-form technical writing.

npm version MIT license Hexo 7 or later Node.js 18 or later

English | 简体中文

Home page in Paper mode

Features

  • Reading-first layouts for home, article, archive, category, tag, tag index, friends and standalone pages
  • Three color modes: follow system, Paper (light) and Ink Night (dark)
  • Cover home page: full-height cover, latest and featured post lists
  • Multilingual UI: English and Simplified Chinese built in, localized routes, translations matched by slug, per-language Atom feeds
  • Reading aids: local search overlay, article table of contents, reading time, related posts, previous/next navigation
  • Code blocks with line numbers, language label and copy button
  • Page meta: Open Graph, Twitter Card, canonical URLs and hreflang alternates
  • Self-hosted webfonts: four families bundled with the theme

Screenshots

The screenshots come from the live demo.

Home page in Ink Night mode Archive page with a taxonomy index and a post list

Article page with a table of contents Code block with line numbers, language label and copy button

Home page on a phone

Requirements

  • Hexo 7 with Node.js 18 or later
  • Hexo 8 with Node.js 20.19 or later
  • hexo-renderer-ejs

Installation

Install the theme in your site:

npm install hexo-theme-zhimo

Activate it in the root _config.yml:

theme: zhimo

Configuration

Theme settings go under theme_config in the root _config.yml, or in a _config.zhimo.yml file next to it. When both are set, theme_config wins.

All options, optional integrations and the theme defaults are in the configuration guide and the theme's _config.yml.

Optional Integrations

  • Local search overlay — install hexo-generator-searchdb; switch the overlay off with theme_config.search.enable: false.
  • Obsidian callouts — install hexo-obsidian-callout and set obsidian_callout.enabled: true.
  • Post image viewer — install photoswipe and set photoswipe.enabled: true.
  • Friends page — add source/_data/friends.yml to the site, documented in the configuration guide.

Contributing

Bugs and feature requests go to the issue tracker. Read the contributing guide before changing code. It covers the source layout, the build pipeline, validation and packaging.

License

Theme code is released under the MIT license. The four bundled fonts, Source Serif 4, Geist Sans, JetBrains Mono NL and Noto Serif SC, are all under OFL-1.1, with license files shipped beside them in source/fonts/.

About

A paper-and-ink, multilingual Hexo theme for long-form technical writing.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages