mirror of https://github.com/halo-dev/halo
📝 更新README
ruibaby
parent
006ab2f949
commit
712f51a0c9
127
README.md
127
README.md
|
|
@ -1,56 +1,37 @@
|
|||
<h1>
|
||||
<a href="#" target="_blank">Halo</a>
|
||||
</h1>
|
||||
<h1 align="center"><a href="https://halo-doc.ryanc.cc" target="_blank">Halo</a></h1>
|
||||
|
||||
> Halo可能是最好的Java博客系统。
|
||||
> Halo 可能是最好的 Java 博客系统。
|
||||
|
||||
[](#)
|
||||
[](https://github.com/ruibaby/halo/releases)
|
||||
[](https://travis-ci.org/ruibaby/halo)
|
||||
[](https://hub.docker.com/r/ruibaby/halo/)
|
||||
<p align="center">
|
||||
<a href="https://ryanc.cc"><img alt="Author" src="https://img.shields.io/badge/author-ruibaby-red.svg?style=flat-square"/></a>
|
||||
<a href="#">
|
||||
<img alt="JDK" src="https://img.shields.io/badge/JDK-1.8-yellow.svg
|
||||
?style=flat-square"/></a>
|
||||
<a href="https://github.com/ruibaby/halo/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/ruibaby/halo.svg?style=flat-square"/></a>
|
||||
<a href="https://travis-ci.org/ruibaby/halo"><img alt="Travis CI" src="https://img.shields.io/travis/ruibaby/halo.svg?style=flat-square"/></a>
|
||||
<a href="https://hub.docker.com/r/ruibaby/halo/"><img alt="Docker Build Status" src="https://img.shields.io/docker/build/ruibaby/halo.svg?style=flat-square"/></a>
|
||||
</p>
|
||||
|
||||
------------------------------
|
||||
🇨🇳简体中文 | 🇺🇸[English](./docs/README-en-US.md) | <img src="https://lipis.github.io/flag-icon-css/flags/4x3/tr.svg" alt="Turkish" height="14"/> [Türkçe](./docs/README-tr.md)
|
||||
|
||||
<details><summary>目录</summary>
|
||||
|
||||
- [简介](#简介)
|
||||
- [快速开始](#快速开始)
|
||||
- [演示](#演示)
|
||||
- [下载部署](#下载部署)
|
||||
- [文档](#文档)
|
||||
- [主题](#主题)
|
||||
- [许可证](#许可证)
|
||||
- [后续功能](#后续功能)
|
||||
- [感谢](#感谢)
|
||||
- [捐赠](#捐赠)
|
||||
|
||||
</details>
|
||||
|
||||
## 简介
|
||||
|
||||
**Halo** [ˈheɪloʊ]，意为光环。当然，你也可以当成拼音读(哈喽)。
|
||||
|
||||
轻快，简洁，功能强大，使用Java开发的博客系统。
|
||||
轻快，简洁，功能强大，使用 Java 开发的博客系统。
|
||||
|
||||
> QQ交流群: 162747721，Telegram交流群：[https://t.me/HaloBlog](https://t.me/HaloBlog)，[WeHalo 小程序](https://github.com/aquanlerou/WeHalo)。
|
||||
> QQ 交流群: 162747721 | Telegram 交流群：[https://t.me/HaloBlog](https://t.me/HaloBlog) | [WeHalo 小程序](https://github.com/aquanlerou/WeHalo)。
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ruibaby/halo.git
|
||||
cd halo
|
||||
mvn clean package -Pprod
|
||||
java -jar target/dist/halo/halo-latest.jar
|
||||
```
|
||||
|
||||
服务器快速部署：
|
||||
|
||||
```bash
|
||||
# 安装Halo
|
||||
# 安装 Halo
|
||||
yum install -y wget && wget -O halo-cli.sh https://git.io/fxHqp && bash halo-cli.sh -i
|
||||
|
||||
# 更新Halo
|
||||
# 更新 Halo
|
||||
bash halo-cli.sh -u
|
||||
```
|
||||
|
||||
|
|
@ -71,18 +52,16 @@ curl https://raw.githubusercontent.com/jwilder/nginx-proxy/master/nginx.tmpl > /
|
|||
# 获取 docker-compose.yaml 文件
|
||||
yum install -y wget && wget -O docker-compose.yaml https://git.io/fpS8N
|
||||
|
||||
# 修改 docker-compose.yaml,修改VIRTUAL_HOST,LETSENCRYPT_HOST为自己的域名,修改LETSENCRYPT_EMAIL为自己的邮箱。
|
||||
vim docker-compose.yaml
|
||||
# 修改 docker-compose.yaml,修改 VIRTUAL_HOST,LETSENCRYPT_HOST 为自己的域名,修改 LETSENCRYPT_I@RYANC.CC 为自己的邮箱。
|
||||
|
||||
# 运行
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
> 注意：如使用Idea，Eclipse等IDE运行的话，需要安装Lombok插件，另外暂不支持JDK10，主题扫描和上传会有问题。
|
||||
> 注意：如使用 Idea，Eclipse 等IDE运行的话，需要安装Lombok插件，另外暂不支持JDK10，主题管理和主题上传会有问题。
|
||||
> 更多请参考[ Halo 使用文档 ](https://halo-doc.ryanc.cc/installation/)或者[ Wiki](https://github.com/ruibaby/halo/wiki)。
|
||||
|
||||
Let's start: http://localhost:8090
|
||||
|
||||
## 演示
|
||||
## 博客示例
|
||||
|
||||
[Ryan0up'S Blog](https://ryanc.cc)
|
||||
|
||||
|
|
@ -94,62 +73,44 @@ Let's start: http://localhost:8090
|
|||
|
||||
[AquanBlog](https://blog.eunji.cn/)
|
||||
|
||||
## 下载部署
|
||||
|
||||
> 如需部署到服务器，请参考[Halo部署教程](https://halo-doc.ryanc.cc/installation/)或者[Wiki](https://github.com/ruibaby/halo/wiki)。
|
||||
|
||||
## 文档
|
||||
|
||||
[Halo Document](https://halo-doc.ryanc.cc)
|
||||
|
||||
> 文档正在不断完善中。
|
||||
|
||||
## 主题
|
||||
|
||||
除了内置的[Anatole](https://github.com/hi-caicai/farbox-theme-Anatole)和[Material](https://github.com/viosey/hexo-theme-material)，还有下列主题没有集成在项目里，如有需要，请自行下载之后通过后台上传上去使用。
|
||||
除了内置的 [Anatole](https://github.com/hi-caicai/farbox-theme-Anatole) 和 [Material](https://github.com/viosey/hexo-theme-material) ，还有下列主题没有集成在项目里，如有需要，请自行下载之后通过后台上传上去使用。
|
||||
|
||||
- [Vno](https://github.com/ruibaby/vno-halo) - 来自Jekyll的一款主题，作者[Wei Wang](https://onevcat.com/)。
|
||||
- [Hux](https://github.com/ruibaby/hux-halo) - 来自Jekyll的一款主题，作者[Xuan Huang](https://huangxuan.me/)。
|
||||
- [Story](https://github.com/ruibaby/story-halo) - 来自Typecho的一款主题，作者[Trii Hsia](https://yumoe.com/)。
|
||||
- [NexT](https://github.com/ruibaby/next-halo) - 来自Hexo的一款主题，作者[iissnan](https://notes.iissnan.com/)。
|
||||
- [Casper](https://github.com/ruibaby/casper-halo) - 来自Ghost的一款主题，作者[Ghost](https://github.com/TryGhost)。
|
||||
- [Vno](https://github.com/ruibaby/vno-halo) - 来自Jekyll的一款主题，作者 [Wei Wang](https://onevcat.com/)。
|
||||
- [Hux](https://github.com/ruibaby/hux-halo) - 来自Jekyll的一款主题，作者 [Xuan Huang](https://huangxuan.me/)。
|
||||
- [Story](https://github.com/ruibaby/story-halo) - 来自Typecho的一款主题，作者 [Trii Hsia](https://yumoe.com/)。
|
||||
- [NexT](https://github.com/ruibaby/next-halo) - 来自Hexo的一款主题，作者 [iissnan](https://notes.iissnan.com/)。
|
||||
- [Casper](https://github.com/ruibaby/casper-halo) - 来自Ghost的一款主题，作者 [Ghost](https://github.com/TryGhost)。
|
||||
|
||||
> 声明：不接受任何对**移植主题**功能上的意见和建议。
|
||||
|
||||
## 许可证
|
||||
|
||||
[](https://github.com/ruibaby/halo/blob/master/LICENSE)
|
||||
[](https://github.com/ruibaby/halo/blob/master/LICENSE)
|
||||
|
||||
> Halo使用GPL-v3.0协议开源，请尽量遵守开源协议，即便是在中国。
|
||||
|
||||
## 后续功能
|
||||
|
||||
- [x] 文章阅读统计
|
||||
- [ ] 文章顶置
|
||||
- [x] 集成又拍云，七牛云等云服务
|
||||
> Halo 使用 GPL-v3.0 协议开源，请尽量遵守开源协议，即便是在中国。
|
||||
|
||||
## 感谢
|
||||
|
||||
Halo的诞生离不开下面这些项目：
|
||||
Halo 的诞生离不开下面这些项目：
|
||||
|
||||
- [IntelliJ IDEA](https://www.jetbrains.com/idea/)：个人认为最强大的Java IDE，没有之一
|
||||
- [Spring Boot](https://github.com/spring-projects/spring-boot)：Spring的快速开发框架
|
||||
- [Spring Boot](https://github.com/spring-projects/spring-boot)：Spring 的快速开发框架
|
||||
- [Freemarker](https://freemarker.apache.org/)：模板引擎，使页面静态化
|
||||
- [H2 Database](https://github.com/h2database/h2database)：嵌入式数据库，无需安装
|
||||
- [Druid](https://github.com/alibaba/druid)：阿里开发的连接池
|
||||
- [Spring-data-jpa](https://github.com/spring-projects/spring-data-jpa.git)：不需要写sql语句的持久层框架
|
||||
- [Spring-data-jpa](https://github.com/spring-projects/spring-data-jpa.git)：不需要写 sql 语句的持久层框架
|
||||
- [Ehcache](http://www.ehcache.org/)：缓存框架
|
||||
- [Lombok](https://www.projectlombok.org/)：让代码更简洁
|
||||
- [oh-my-email](https://github.com/biezhi/oh-my-email)：可能是最小的Java邮件发送库了，支持抄送、附件、模板等
|
||||
- [Hutool](https://github.com/looly/hutool)：一个Java基础工具类库
|
||||
- [oh-my-email](https://github.com/biezhi/oh-my-email)：可能是最小的 Java 邮件发送库了，支持抄送、附件、模板等
|
||||
- [Hutool](https://github.com/looly/hutool)：一个 Java 基础工具类库
|
||||
- [Thumbnailator](https://github.com/coobird/thumbnailator)：缩略图生成库
|
||||
- [AdminLTE](https://github.com/almasaeed2010/AdminLTE)：基于Bootstrap的后台模板
|
||||
- [Bootstrap](https://github.com/twbs/bootstrap.git)：使用最广泛的前端ui框架
|
||||
- [Animate](https://github.com/daneden/animate.css.git)：非常好用的css动效库
|
||||
- [SimpleMDE - Markdown Editor](https://github.com/sparksuite/simplemde-markdown-editor)：简洁，功能够用，且轻量级的Markdown编辑器
|
||||
- [Bootstrap-FileInput](https://github.com/kartik-v/bootstrap-fileinput.git)：个人认为最好用的上传组件，没有之一
|
||||
- [AdminLTE](https://github.com/almasaeed2010/AdminLTE)：基于 Bootstrap 的后台模板
|
||||
- [Bootstrap](https://github.com/twbs/bootstrap.git)：使用最广泛的前端 ui 框架
|
||||
- [Animate](https://github.com/daneden/animate.css.git)：非常好用的 css 动效库
|
||||
- [SimpleMDE - Markdown Editor](https://github.com/sparksuite/simplemde-markdown-editor)：简洁，功能够用，且轻量级的 Markdown 编辑器
|
||||
- [Bootstrap-FileInput](https://github.com/kartik-v/bootstrap-fileinput.git)：基于 Bootstrap 的文件上传组件
|
||||
- [Font-awesome](https://github.com/FortAwesome/Font-Awesome.git)：使用最广泛的字体图标库
|
||||
- [Jquery](https://github.com/jquery/jquery.git)：使用最广泛的JavaScript框架
|
||||
- [Jquery](https://github.com/jquery/jquery.git)：使用最广泛的 JavaScript 框架
|
||||
- [Layer](https://github.com/sentsin/layer.git)：个人认为最实用最好看的弹出层组件，没有之一
|
||||
- [Jquery-Toast](https://github.com/kamranahmedse/jquery-toast-plugin)：消息提示组件
|
||||
- [Pjax](https://github.com/defunkt/jquery-pjax.git)：pushState + ajax = pjax
|
||||
|
|
@ -157,10 +118,20 @@ Halo的诞生离不开下面这些项目：
|
|||
|
||||
## 捐赠
|
||||
|
||||
> 如果Halo对你有帮助，可以请作者喝瓶娃哈哈哈哈哈哈哈哈哈哈。
|
||||
> 如果 Halo 对你有帮助，可以请作者喝杯☕️。
|
||||
|
||||
| 支付宝 | 微信 | 支付宝红包 |
|
||||
| :------------: | :------------: | :------------: |
|
||||
| <img src="https://cdn.ryanc.cc/img/github/donate/alipay.png" width="150"/> | <img src="https://cdn.ryanc.cc/img/github/donate/wechat.png" width="150" /> | <img src="https://cdn.ryanc.cc/img/github/donate/hongbao.png" width="150" /> |
|
||||
|
||||
## 界面展示
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue