Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

hexo-theme-keep

XPoet4.2kAGPL-3.04.2.5

A simple and light theme for Hexo.

hexo, theme, hexo-theme, simple, elegant, beautiful, powerful

readme

Language: English | 简体中文 | 繁體中文

Keep

hexo-theme-keep

Keep is a simple and light Hexo theme. It makes you more focused on writing.

Github License Github Release NPM Version NPM Downloads Node.js Version Required Hexo version

:star2: Online Preview

If you want to put a link to your blog in the online preview list, you can give the author a PR.

:books: Documents

Please see the official documents of Keep.

:rocket: Installation

If you're using Hexo 5.0 or later, the simplest way to install is through NPM:

# recommend

cd your-hexo
npm install hexo-theme-keep

Or you can clone the entire repository:

cd your-hexo
git clone https://github.com/XPoet/hexo-theme-keep --depth=1 themes/keep

After the installation, open Hexo config file and set theme variable to keep.

theme: keep

:tada: Update

Keep releases new versions from time to time. You can update Keep by the following command.

Install the latest version through NPM:

# recommend

cd your-hexo
npm install hexo-theme-keep@latest

Or update to the latest master branch:

cd themes/keep
git pull

It is not recommended to directly modify any files in the Keep theme. Because this may cause errors (e.g. merge conflicts), and the modified files may be discarded when upgrading the theme.

:art: Contributors

This project exists thanks to all the people who contribute.

We welcome you to join the development of Keep. Please see contributing guide.

:sparkling_heart: Thanks

Keep send special thanks to these great services that sponsor our core infrastructure:

  • GitHub allows us to host the Git repository and run the test suite.
  • Thanks cdnjs, jsDelivr and UNPKG for providing public CDN service.

:memo: License

AGPL-3.0

Copyright © 2020-present XPoet

changelog

Changelog

4.2.5 (2024-11-25)

🐞 Bug Fixes

🎯 CI

4.2.4 (2024-11-21)

🐞 Bug Fixes

  • fix the footer copyright period when it is within the same year (c999714)

🎨 Styling

  • optimize element block z-index order (#366) (b654489)

🛠 Performance Improvements

  • enhanced protection against third-party css style intrusions (#370) (573bc3c)
  • optimize footer since year settings (19be89b)
  • optimize the display of post update time (#369) (c57764d)

🎯 CI

💄 Improvement UI

🚦 Chore

  • upgrade the comment plugins version (59dc05e)

4.2.3 (2024-09-09)

🎯 CI

💄 Improvement UI

🚦 Chore

4.2.2 (2024-08-19)

🐞 Bug Fixes

  • fix the error caused by closing lazy loading of images (#365) (5dede08)

4.2.1 (2024-07-29)

📖 Docs

  • language: update Traditional Chinese (9330df8)

💄 Improvement UI

  • optimize the style of the secondary navigation menu (075429b)

4.2.0 (2024-07-15)

🌟 Features

  • supports secondary menu configuration in mobile (7b32ee5)
  • supports secondary menu configuration in pc (ae9fa33)

🐞 Bug Fixes

  • fixed the problem of code block fold failure (#346) (dfb0758)
  • optimize judgment logic of scroll to top of page (#342) (017540a)

🍭 Code Refactoring

  • refactoring page template usage logic (ab51486)

🛠 Performance Improvements

💄 Improvement UI

  • clear header shrink after page jump (748ed43)
  • optimize markdown style (d486a7d)
  • optimize reward author style (12d9215)

4.1.5 (2024-07-05)

🛠 Performance Improvements

  • home: optimize post updated time settings (b444efd)
  • post: optimize article encryption function (b189db5)

🎯 CI

4.1.4 (2024-07-03)

🐞 Bug Fixes

🛠 Performance Improvements

  • built-in article encryption function (54bf474)

🎯 CI

💄 Improvement UI

  • optimize archive page style (58aaf7d)

4.1.3 (2024-05-29)

🛠 Performance Improvements

  • comment: optimize Twikoo version number matching (04047da)
  • comment: optimize Waline version number matching (a7ec00b)
  • optimize the matching of menu navigation (0ada7b9)
  • supports configuring code block shrink for each post (a187c4a)
  • supports configuring initial theme mode (#327) (5e31bef)

🎯 CI

💄 Improvement UI

4.1.2 (2024-05-15)

🍭 Code Refactoring

  • footer: support fill in more record information (#316) (c2c9232)
  • optimize the directory structure of the page (b758c89)

🛠 Performance Improvements

  • comment: optimize version matching of waline (1c2895b)
  • comment: support Waline v3 (#322) (4145926)
  • toc: support encrypted article display toc (#323) (1529ba0)

🎯 CI

💄 Improvement UI

4.1.1 (2024-04-03)

🐞 Bug Fixes

  • toc: fixed active index error when header is displayed (fdd76b3)

💄 Improvement UI

  • add site deploy provider (7af3c52)

4.1.0 (2024-03-12)

🌟 Features

  • active tool category tab when scroll (d095039)
  • add custom setting post copyright info (#305) (8e4e1e4)
  • add tools page template (f48d6bd)
  • can set icon for navigation menu (2301d8c)
  • can set the datetime type of home page post block (#300) (18f28d1)
  • post can be viewed in full screen (188c70c)
  • social contact links add X (39df4b7)
  • support custom set datetime icon in home post block (#300) (fc9a1de)
  • support custom set datetime icon of post page (#301) (5459de6)
  • support set datetime format in home post block (#300) (7c0665e)

🐞 Bug Fixes

  • optimize the settings of menu icon (5762a9c)

🛠 Performance Improvements

  • optimize comment plugin anchor jump (cc194a4)
  • optimize page template render (b667036)

💄 Improvement UI

  • optimize home cover style in mobile (5eb0512)
  • optimize page content max width (82aa999)
  • optimize page template style (0d23aa6)
  • optimize post meta info tag style (6915333)
  • optimize tools page style (1417b2c)
  • optimize tools page template style (f415514)

🚦 Chore

  • rename --components-spacing -> --component-gap (a8d2d96)
  • update theme config (29b6182)

4.0.7 (2024-02-18)

📖 Docs

🎯 CI

💄 Improvement UI

  • comment: optimize light and dark mode switch (5aa2cca)
  • optimize category item style (#299) (0943611)
  • update first screen background images (c068e7a)
  • use css variable to control the display of post author name (#302) (95ac9c1)

4.0.6 (2024-01-02)

🛠 Performance Improvements

  • cdn configuration adds cdnjs settings item (f21ee56)
  • optimize post meta info (ad55c9f)

💄 Improvement UI

  • modify code block shrink line icon (812dfbf)
  • optimize theme mode settings (#295) (22d8b8e)

4.0.5 (2023-12-01)

🎯 CI

💄 Improvement UI

  • optimize 404 page style (403e8e2)
  • optimize copyright info style (3ed9c56)

4.0.4 (2023-12-01)

🐞 Bug Fixes

  • Unable to scroll horizontally when the code length is too long (8d6ca63)
  • Unable to scroll horizontally when the code length is too long (44df85e)

🍭 Code Refactoring

🛠 Performance Improvements

  • code-block: optimize style handle after expand codes (#284) (98cda7a)
  • optimize image lazyload (595812b)
  • optimize markdown img align settings (bd548c9)
  • optimize zoom in image handle logic (1f2fbc7)

📦 Build System

💄 Improvement UI

  • use css variable setting post title align (71c3150)

4.0.3 (2023-11-30)

📖 Docs

🛠 Performance Improvements

  • optimize img src url generation (5a09946)
  • optimize the page path judgment logic (2437a13)

🎯 CI

💄 Improvement UI

  • optimize markdown style (3251093)
  • page-template: add page cover settings (2b0c227)

4.0.2 (2023-11-29)

🐞 Bug Fixes

  • fix click site name/logo changes the language (49256cb)

📖 Docs

🛠 Performance Improvements

  • optimize H tag title anchor jump (57236c2)
  • optimize img src url generation (23d6283)
  • optimize root path jump (046c3f1)
  • website announcement support the markdown syntax (7189ead)

🎯 CI

💄 Improvement UI

  • 404: disable user select (727046c)
  • optimize markdown style (3540d32)

4.0.1 (2023-11-22)

🐞 Bug Fixes

  • copyright-info: optimize page disable copyright info (5a0d631)

🎨 Styling

  • print theme information at startup (82cef1d)

🛠 Performance Improvements

  • optimize a tag anchor jump (632a182)
  • post: enhanced front-matter settings (2cd5444)

💄 Improvement UI

  • add 404 page (5b74110)
  • comment: optimize waline style (a03054b)
  • markdown: optimize code block style (255910f)

4.0.0 (2023-11-13)

⚠ BREAKING CHANGES

  • add website announcement settings
  • optimize configuration items of keep theme
  • reconstructs the post.author_badge configuration items
  • reconstructs the home_article configuration items

🌟 Features

  • add scroll.hide_header configuration item (1bc6ba1)
  • add Artalk comment plugin (#193) (dbf14a7)
  • add photos page template (9cd51b7)
  • add website announcement settings (2046a97)
  • first-screen: add background_img_dark configuration item (dceafaa)
  • friends-link: add classification fold function (cd6c654)

🐞 Bug Fixes

  • fixed table content overflow container (#273) (6aad228)
  • toc: optimize header hide handle for anchor jump (671e4c5)

🎨 Styling

  • optimal naming of toggle theme (1fc591d)

🍭 Code Refactoring

  • reconstructs the first_screen configuration items (ba0d7a1)
  • reconstructs the home_article configuration items (e07247b)
  • reconstructs the post.author_badge configuration items (b7f320a)
  • reconstructs the scroll configuration items (a8909aa)
  • reconstructs the style configuration items (f68b369)

🛠 Performance Improvements

  • backdrop-filter: blur() support Safari browser (47732b9)
  • comment: optimize Artalk init load (8f633ec)
  • comment: optimize Disqus load (5d09035)
  • comment: optimize Waline init load (04d0fd3)
  • first-screen: add font family css variable (f22fc20)
  • first-screen: add icon color css variable (c1f6172)
  • optimize comment plugin load logic (83711e9)
  • optimize i18n (a17b58a)
  • use css variable setting blog title (d485b30)

📦 Build System

  • optimize configuration items of keep theme (27bb7d9)

🎯 CI

💄 Improvement UI

  • comment: add disqus support (2a6ad4e)
  • first: use css variable control offset and display (c6fd66b)
  • global: optimize basic style (dfe304a)
  • optimize home page style (19580b3)
  • optimize shrink code line style (9e10353)
  • post: shrink the code block initially (e833e49)
  • use css variable setting header font color (0a139c5)

3.8.6 (2023-10-26)

🛠 Performance Improvements

  • first-screen: support for configuring custom svg icons (#213) (1198444)

3.8.5 (2023-10-17)

📖 Docs

🛠 Performance Improvements

  • comment: supports waline extension to fill in more properties (#232) (626296e)
  • use CSS variables to control components spacing (1ed1077)
  • use CSS variables to control the layout of page content (97fbe6d)

🎯 CI

  • update GitHub Actions configuration (24969ca)

💄 Improvement UI

  • adapt the style of hexo-blog-encrypt plugin (0a30fc4)

3.8.4 (2023-10-12)

📖 Docs

🎯 CI

  • update GitHub ISSUE_TEMPLATE (496ea15)

💄 Improvement UI

  • optimize wechat share style (dd03d61)

3.8.3 (2023-10-11)

🐞 Bug Fixes

  • fixed abnormal page scrolling (a4e5684)

🛠 Performance Improvements

  • add --header-backdrop-filter-blur css variable (8291ad0)
  • optimize custom tag plugins (596d255)
  • remove first_screen.header_transparent configuration item (798d0d2)
  • support mermaid.js (74e4aec)

💄 Improvement UI

  • optimize home article block style (f80400d)
  • post: color the bottom tags (ca88520)

🚦 Chore

  • update sponsor custom link (0df5de7)

3.8.2 (2023-10-07)

🐞 Bug Fixes

  • update CC BY-NC-SA 4.0 jump link (#257) (c088a6a)
  • utils: improve removeWhitespace() (d556159)

🎯 CI

  • update GitHub ISSUE_TEMPLATE (2700943)

💄 Improvement UI

  • optimize post meta info bar style (cb7a27c)
  • post: optimize TOC anchor jump (828c1be)

3.8.1 (2023-09-27)

🛠 Performance Improvements

  • optimize header shrink handle in the initial state (2002162)
  • optimize header shrink handle logic (e7064e5)

🎯 CI

  • update GitHub ISSUE_TEMPLATE (ebe0ba7)

💄 Improvement UI

  • hide first screen description in the initial state (b51013e)
  • optimize reward author button style (f5820ad)
  • unify the style of post tags (2986c29)

3.8.0 (2023-09-26)

🌟 Features

  • add custom button tag in post (2363829)
  • add custom note tag in post (ab6c379)
  • add custom tag tabs (3720483)
  • add the ability to share post (5745c71)
  • allow custom reward text (a163a78)
  • first screen description add typewriter effect (1793583)
  • front-matter: add home_cover and post_cover settings (10abbe2)
  • post: added reward author configuration (47b3849)

🐞 Bug Fixes

  • allow mobile website to adjust font size (c323da5)
  • fixed hexo build error (3aa47db)
  • fixed the copy code button was not visible in Mac style (8235b96)
  • home: fixed a bug show two stick icon (105fab5)
  • optimize article meta info icon (72157d9)
  • optimize busuanzi script load (1bc6a27)
  • optimize lazyload of tooltip-img component (e3a1a6e)
  • prevent page flicking after click 'back2top' button (08efbe4)

🎨 Styling

  • function naming optimization (ed08e3f)

🍭 Code Refactoring

  • refactor back2top and back2bottom (d0eae9f)

🛠 Performance Improvements

  • custom injected JS files adapted to PJAX (a0f5a9f)
  • normalizes the tooltip component (2e805ec)
  • optimize back2Top display logic (da77c5c)
  • optimize TOC handle logic (9403947)
  • optimize tooltip-img component custom style setting (455857b)

📦 Build System

  • fontawesome-free upgrade to v6.4.2 (d97aa97)
  • optimize js files load for PJAX (88f7bf4)
  • optimize JS for handling copyright info (6e45812)
  • optimize JS for post share (76da72e)
  • update twikoo comments config (db5e327)

💄 Improvement UI

  • always display back2Top (79464a6)
  • optimize blockquote tag style (0428295)
  • optimize custom button tag style (40d0aa1)
  • optimize friends link page style (134c99f)
  • optimize post share layout (4141cf4)
  • optimize reward author button style (5c6a041)
  • optimize the bottom style of the page (b05ba63)

🚦 Chore

3.7.7 (2023-09-12)

🐞 Bug Fixes

  • copyright-info: raises the z-index of the content container (683c581)

💄 Improvement UI

  • archives: display articles using a timeline style (dac86a1)
  • optimize category content page style (bb2e0ad)
  • optimize mobile style (98fcae3)
  • optimize tag content page style (6a4ee2e)
  • optimize the post sticky style for mobile (03400da)
  • post: optimize TOC style (fee8375)

🚦 Chore

  • adjust the directory structure and naming of CSS files (ac9c67c)
  • post: optimize comments anchor setting (8a4a8ce)

3.7.6 (2023-09-08)

🐞 Bug Fixes

  • fixed the error of inconsistent post updated datetime (d78f98a)

🎯 CI

  • auto release description add emoji icon (ccd31c8)

💄 Improvement UI

  • copy copyright info icon change to always display (dda328a)
  • home: increase post cover height (ddf5e56)
  • optimize post copyright style (cb03fd1)
  • optimize post title display (212d638)

🚦 Chore

  • i18n: update languages (fb33a9e)
  • update configuration file comments (fce2339)

3.7.5 (2023-09-07)

Bug Fixes

  • home: fixed calculation error in how long ago the post was updated (7187d4e)
  • optimize side tools bar position setting (082b637)
  • toc: fixed an error when removeChild (8c004a4)

Improvement UI

  • home: optimize the top effect of posts (85e1bdf)
  • optimize side tools show logic (7323de5)
  • optimize tools display position (1b15431)
  • post content page added cover display (90ef133)
  • update keep-container box-shadow style (58adea9)

3.7.4 (2023-09-04)

Bug Fixes

  • fixed GitHub actions configuration item error (9817506)
  • footer: optimize version number settings (e8b8b94)

Styling

  • reduce image brightness in dark mode (08a25ac)

Build System

CI

  • unify the commit lint type (5ae7905)
  • use auto release version (e72063e)

Improvement UI

Chore

  • actions: add issue template (74b3da2)
  • optimize version number setting (fdc7061)