Skip to content

Latest commit

 

History

History
75 lines (59 loc) · 4.47 KB

README_en.MD

File metadata and controls

75 lines (59 loc) · 4.47 KB

📣 Announcement

Your ShokaX and Shoka sites might be under a supply chain attack
Survey on ShokaX deployment platform and Astro migration

hexo-theme-shokaX

LICENSE stars version build

Language: Simplified Chinese | English \

This project is a secondary development version of Shoka (considered a spiritual successor), dedicated to improving performance and optimizing the custom modification experience.
The reason for its creation is that Shoka hasn't been updated for three years, accumulating a large number of bugs and feature requests.

ShokaX's community resource guide and plugin repository can be found at awesome-shokaX.

💬 Differences from Shoka

The original Shoka used javascript+Native+nunjucks technology,
while ShokaX uses typescript+Vue 3+Pug technology.
Many inaccessible CDN links have been changed.

✨ Feature List

Feature Name Status Feature Name Status
PWA Support JSD Split
API Injection Community Plugin System
Custom Fonts ✅* Custom Styles ✅*
Multiple Comment Systems Support AI-Generated Article Summary 🔬
Footer Record Number Custom Footer ✅*
CSS Gradient Cover Typescript Support

Notes:

  • *: Requires API injection
  • 🔬: Experimental, may have issues

🔧 How to Install?

Note: This project requires node.js version 18.x or higher to run.
See the installation guide in the documentation.

📚 Sub-Projects

  • ShokaX docs ShokaX theme documentation (currently being written, feel free to join!)
  • HRMNMI Markdown renderer used by ShokaX (awaiting refactoring)
  • ShokaX Pjax Efficient Pjax implementation provided by ShokaX
  • ShokaX Anime Simplified version of Anime.js provided by ShokaX

License: AGPL 3 or later

Special Notes

The AGPL license primarily aims to restrict modified distribution behavior to avoid unauthorized secondary modifications and commercial packaging.
Any modifications to the source code must be open-sourced because, according to the AGPL license, building a website requires the modified portions to be open-sourced.

Special Usage Instructions

According to AGPLv3 Section 7, we have added some additional terms:
Please see Usage Restrictions. By using ShokaX, you acknowledge this file's content.

Acknowledgements

Open Source Projects

Name Author Description
Hexo Hexo contributors Provided a great foundation for this project
hexo-theme-shoka amehime Parent theme of this project

Developers

Hexo theme:

ShokaX documentation:

Special Thanks

Other Information

Star history chart