Awesome

About The Project

A modern and minimalist blog theme, suitable for Halo 2.x.Fast iteration with diverse features.Adopting a card-style design solution and responsive design for a better mobile experience.

Build With.

This project is proudly built on the following technologies.

1. Halo
2. Tailwind CSS
3. alpinejs
4. tocbot
5. iconify-json
6. tailwindcss-plugin-icons

This project proudly utilizes the following design resources.

1. 国内社交媒体图标合集 | by 展哥更新了
2. Octicons | by Github
3. heroicons
4. tablers
5. Unicon | by IconScout
6. Brands logos | By Andrey Kovalev

If there are any outstanding matters, please contact AlkaidMegrez(AlkaidMegrez@outlook.com) for feedback.

Getting Started

You can go to the Release page to download the latest version, or follow the steps below to compile it yourself.

Compile

1. Clone the repo

   git clone https://github.com/Shine-Theme/halo-theme-crux.git
   

2. Install NPM packages

   pnpm install
   

3. Customize Your Theme

   pnpm run dev
   

4. Compile your static resources

   pnpm run build
   

5. ZIP your file

   *The following content needs to be included in your ZIP file
   *For reference only.
   
   .
   ├── templates
   │   ├── modules
   │   │   ├── components
   │   │   │   ├── archives-post-card.html
   │   │   │   ├── footer-basic.html
   │   │   │   ├── footer.html
   │   │   │   ├── health-check.html
   │   │   │   ├── hero.html
   │   │   │   ├── nav.html
   │   │   │   ├── post-card.html
   │   │   │   ├── social-card.html
   │   │   │   ├── social.html
   │   │   │   └── user-card.html
   │   │   ├── icon
   │   │   │   ├── github.html
   │   │   │   ├── links.html //remove soon
   │   │   │   └── qq.html
   │   │   └── layout.html
   │   ├── assets
   │   │   └── dist
   │   │       ├── main.iife.js
   │   │       └── style.css
   │   ├── archives.html
   │   ├── author.html
   │   ├── categories.html
   │   ├── category.html
   │   ├── index.html
   │   ├── links.html
   │   ├── moments.html
   │   ├── page.html
   │   ├── page_about_personal.html
   │   ├── page_github.html
   │   ├── photos.html
   │   ├── post.html
   │   ├── tag.html
   │   └── tags.html
   ├── annotation-setting.yaml
   ├── settings.yaml
   └── theme.yaml
   

Usage

Upload your ZIP file to your blog system (Halo 2.x) and enable your theme, following the documentation or availability testing to perfect the settings.

Then enjoy the fruits of your labor.

Roadmap

• Responsive design

• Full route adaptation

• Availability testing

• Posts toc

• Dark Mode(coming soon...)

• Personalized Page

  • Personal About Page(To be optimized.)
  • Github(To be optimized.)
  • Team About Page(coming soon...)
  • Bilibili
  • Douban

• We always on the road...

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

License

MIT License

Copyright (c) 2023 Shine Theme Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contact

AlkaidMegrez - AlkaidMegrez@outlook.com

Project Link: https://github.com/Shine-Theme/halo-theme-crux

Special thanks

Thank you to the following organizations or individuals for their strong support during the improvement process of this project.

• Halo Team
• ruibaby
• loongzcode