From db68951833687a7f24eda85b73c1227f5ef49c59 Mon Sep 17 00:00:00 2001 From: Stan_k <56168768+Stan370@users.noreply.github.com> Date: Sun, 3 Nov 2024 15:02:35 +0800 Subject: [PATCH 1/4] Update README.md --- README.md | 80 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 64 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 57923b5..01535d5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # [stanBlog](https://stan370.github.io/) -A beautiful hexo blog theme with material design and responsive design with reference to BlinkFox. +StanBlog是一个基于Hexo和EJS模板引擎的博客主题，具有材料设计和响应式设计的特点。它是一个全面、美观的个人技术博客主题，支持 Markdown 和 HTML 语法，自带 RSS 和 Atom 订阅功能，支持自定义主题和布局，支持代码高亮和语法检查，支持移动设备访问。 +A beautiful hexo blog theme with material design and responsive design. image @@ -11,21 +12,51 @@ A beautiful hexo blog theme with material design and responsive design with refe ## Features -- Simple and beautiful, and post is Beautiful and readable. -- [Material Design](https://material.io/). -- Responsive design, which can be displayed well on desktop, tablet, mobile phone, etc. -- Home page carousel posts and changing 'banner' picture dynamically everyday. -- Blog posts list with waterflow (There will be 24 images if the article doesn't have featured pictures). -- Archive page with timeline. -- Tags page of the **word cloud** and categories page of the **radar chart** -- Rich 'About' page (including about me, posts charts, my projects, my skills, gallery etc.) -- Friendly link page for customizable data -- Support post topping and rewards -- Support `MathJax` -- TOC -- Can be set append the copyright information when copying the content of the post -- Can be set to do password verification when reading a post - +* 使用Hexo作为博客框架 +* 使用EJS作为模板引擎 +* 支持 Markdown 和 HTML 语法 +* 自带 RSS 和 Atom 订阅功能 +* 支持自定义主题和布局 +* 支持代码高亮和语法检查 +* 支持移动设备访问 +* 简单美观的设计，文章页面美观易读 +* 支持Material Design- [Material Design](https://material.io/). +* 响应式设计，适用于桌面、平板、手机等设备 +* 首页轮播文章和每日动态更换的banner图片 +* 文章列表采用瀑布流布局（如果文章没有特色图片，则显示24张图片） +* 归档页面采用时间轴布局 +* 标签页面采用词云布局，分类页面采用雷达图布局 +* 丰富的"关于"页面（包括关于我、文章统计、我的项目、我的技能、相册等） +* 友情链接页面支持自定义数据 +* 可以设置在复制文章内容时追加版权信息 +* 可以设置阅读文章时需要密码验证 + +## 项目结构 +``` +├── _config.yml +├── package.json +├── scaffolds +│ ├── draft.md +│ ├── page.md +│ └── post.md +├── scripts +│ ├── deploy.sh +│ └── server.sh +├── source +│ ├── _drafts +│ ├── _posts +│ └── index.ejs +├── themes +│ └── ejs-theme +│ ├── _config.yml +│ ├── layout.ejs +│ ├── index.ejs +│ └── partials +│ ├── footer.ejs +│ ├── header.ejs +│ └── sidebar.ejs +└── yarn.lock +``` ## Fork 指南 @@ -57,6 +88,23 @@ Fork 本项目之后，还需要做一些事情才能让你的页面「正确」 pages/about.md 文件内容对应网站的「关于」页面，里面的内容多为个人相关，将它们替换成你自己的信息，包括 \_data 目录下的 skills.yml 和 social.yml 文件里的数据。 +6. 进行本地部署测试 +部署您的博客 +您需要选择一种部署方法。Hexo支持GitHub Pages、Vercel等多种平台。以下是如何设置GitHub页面： +``` +npm install hexo-deployer-git --save + +Configure deployment in _config.yml: +deploy: + type: git + repo: + branch: gh-pages +Generate and Deploy: + +hexo generate +hexo deploy +``` +Layouts and Partials: EJS themes often use .ejs files for layouts and partials. For example, layout.ejs might be the main layout file where you define the structure of your pages. ## 致谢 From 43d7e63544a9f9218bf0e4a6e0f2b662973ee74d Mon Sep 17 00:00:00 2001 From: Stan_k <56168768+Stan370@users.noreply.github.com> Date: Sun, 3 Nov 2024 15:04:58 +0800 Subject: [PATCH 2/4] Create README.en.md --- README.en.md | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..9bac592 --- /dev/null +++ b/README.en.md @@ -0,0 +1,110 @@ +# [stanBlog](https://stan370.github.io/) +**StanBlog** is a blog theme built with Hexo and the EJS template engine, featuring material design and responsive layouts. This comprehensive, visually appealing personal tech blog theme supports Markdown and HTML syntax, offers built-in RSS and Atom feeds, customizable themes and layouts, code highlighting, and syntax checking, as well as mobile device access. + +A beautiful Hexo blog theme with material design and responsive design. + +image + +> - 🔁 Project synced at: [Github](https://github.com/Stan370/stan370.github.io/) +> - 📖 Ebook reader at: [Github Pages](https://stan370.github.io//) + +## Features + +* Uses Hexo as the blogging framework +* Uses EJS as the template engine +* Supports Markdown and HTML syntax +* Built-in RSS and Atom feed support +* Customizable themes and layouts +* Code highlighting and syntax checking +* Mobile device support +* Clean, visually appealing design with easy-to-read article pages +* Supports Material Design - [Material Design](https://material.io/) +* Responsive layout for desktop, tablet, and mobile +* Carousel articles on the homepage with a daily changing banner image +* Waterfall layout for the article list (24 default images displayed if no feature image is provided) +* Timeline layout for the archive page +* Tag page displayed as a word cloud, category page displayed as a radar chart +* Rich "About" page (includes About Me, article stats, my projects, my skills, photo album, etc.) +* Customizable data for the Links page +* Option to add copyright information when copying article content +* Option for password protection on articles + +## Project Structure +``` +├── _config.yml +├── package.json +├── scaffolds +│ ├── draft.md +│ ├── page.md +│ └── post.md +├── scripts +│ ├── deploy.sh +│ └── server.sh +├── source +│ ├── _drafts +│ ├── _posts +│ └── index.ejs +├── themes +│ └── ejs-theme +│ ├── _config.yml +│ ├── layout.ejs +│ ├── index.ejs +│ └── partials +│ ├── footer.ejs +│ ├── header.ejs +│ └── sidebar.ejs +└── yarn.lock +``` + +## Fork Guide + +After forking this project, you'll need to complete a few steps to set up your own blog page. + +1. **Set the correct project name and branch.** + + According to GitHub Pages guidelines, a project named `username.github.io` on the master branch or a project with a different name on the gh-pages branch can automatically generate a GitHub Pages page. + +2. **Modify the domain.** + + If you want to bind a custom domain, modify the content of the CNAME file and follow [GitHub Pages Custom Domain Configuration](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site). If you don't need a custom domain, delete the CNAME file. + +3. **Edit the configuration.** + + The site configuration is primarily in the `_config.yml` file. Update the personal information fields, such as `url`, `title`, `subtitle`, and any third-party comment module settings, as needed. Use a CDN such as JsDelivr to accelerate file loading from GitHub. + +4. **Remove my posts and images.** + + You can delete all content in the following folders, except for the `template.md` file, and add your content: + + * The `_posts` folder contains my published blog posts. + * The `_drafts` folder contains my unpublished drafts. + * The `_wiki` folder contains my published wiki pages. + * The `images` folder contains images used in articles and pages. + +5. **Update the "About" page.** + + The `pages/about.md` file corresponds to the "About" page, which contains personal information. Update it with your details, including `skills.yml` and `social.yml` in the `_data` directory. + +6. **Test Locally and Deploy** + +To deploy, choose a method such as GitHub Pages or Vercel. Here's a quick setup guide for GitHub Pages: + +``` +npm install hexo-deployer-git --save + +Configure deployment in _config.yml: +deploy: + type: git + repo: + branch: gh-pages +Generate and Deploy: + +hexo generate +hexo deploy +``` + +## Acknowledgments + +This theme is based on [BlinkFox](http://blinkfox.com/) with modifications—thank you! + +The longer a piece of code is intended to last, the cleaner it should be. Temporary code, like quick scripts, can be less strict. Conversely, only clean code can achieve exceptional longevity. From 74ed79c5196681f2180bce6248fee494fc6fc647 Mon Sep 17 00:00:00 2001 From: Stan_k <56168768+Stan370@users.noreply.github.com> Date: Sun, 3 Nov 2024 15:05:57 +0800 Subject: [PATCH 3/4] Update LICENSE --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index d1a0076..ec7bb15 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 luuuuuuuuuu +Copyright (c) 2024/06/17 - Stan. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From 6fe2923b496b701e160dcbde7232c98aedfb09c6 Mon Sep 17 00:00:00 2001 From: Stan_k <56168768+Stan370@users.noreply.github.com> Date: Sun, 3 Nov 2024 15:06:12 +0800 Subject: [PATCH 4/4] Update LICENSE --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index ec7bb15..f9a64d8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024/06/17 - Stan. All rights reserved. +Copyright (c) 2024/11/03 - Stan. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal