halo/README.md

113 lines
4.5 KiB
Markdown
Executable File
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<h1 align="center"><a href="https://github.com/halo-dev" target="_blank">Halo</a></h1>
> Halo 是一款现代化的个人独立博客系统,给习惯写博客的同学多一个选择。
<p align="center">
<a href="https://github.com/halo-dev/halo/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/halo-dev/halo.svg?style=flat-square"/></a>
<a href="https://github.com/halo-dev/halo/releases"><img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/halo-dev/halo/total.svg?style=flat-square"></a>
<a href="https://hub.docker.com/r/ruibaby/halo"><img alt="Docker pulls" src="https://img.shields.io/docker/pulls/ruibaby/halo?style=flat-square"></a>
<a href="https://github.com/halo-dev/halo/commits"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/halo-dev/halo.svg?style=flat-square"></a>
<a href="https://travis-ci.org/halo-dev/halo"><img alt="Travis CI" src="https://img.shields.io/travis/halo-dev/halo.svg?style=flat-square"/></a>
</p>
------------------------------
## 简介
**Halo** `[ˈheɪloʊ]`,意为光环。当然,你也可以当成拼音读(哈喽)。
一个优秀的开源博客发布应用,值得一试。
> [官网 & 文档](https://halo.run) | [社区](https://bbs.halo.run) | [Telegram 频道](https://t.me/halo_dev)
## 声明
> 本项目旨在创造一个好的产品以供人们使用虽然现在并不是太好并非一个所谓提供学习的项目。所以不提供任何学习代码的帮助。也请不要在讨论群issues论坛发起任何有关代码学习的问题。当然如果你是要参与代码贡献我们非常欢迎。
另外,写给想自己拉代码编译运行的同学:
> 目前我们的开发分支即 master肯定会有很多小问题不要运行不起来就跑过来吐槽什么代码开源不完整之类的多找找自己的原因。同时建议下载最新 release 版本的代码,或者在 master 分支执行 `git checkout v1.3.2`。
PS实在不想写这个声明影响 README 的美观),但是就目前来看,写在 README 上是有必要的,因为大部分遇到问题的人都不会去仔细阅读文档。
## 快速开始
### 下载最新的 Halo 安装包
> 其他地址https://halo.run/archives/download.html
```bash
curl -L https://github.com/halo-dev/halo/releases/download/v1.3.2/halo-1.3.2.jar --output halo-latest.jar
```
或者
```bash
wget https://github.com/halo-dev/halo/releases/download/v1.3.2/halo-1.3.2.jar -O halo-latest.jar
```
### 启动 Halo
```bash
java -jar halo-latest.jar
```
详细部署文档请移步:<https://halo.run/archives/install-quick-start.html>
## 博客示例
请移步: <https://halo.run/p/user-wall.html>
## 周边
- 后台管理halo-admin<https://github.com/halo-dev/halo-admin>
- 独立评论模块halo-comment<https://github.com/halo-dev/halo-comment>
- 管理 APP已停止维护<https://github.com/halo-dev/halo-app>
- 主题仓库:<https://halo.run/p/themes.html>
- 资源下载:<https://dl.halo.run>
- WeHalo 小程序:<https://github.com/aquanlerou/WeHalo>
## 许可证
[![license](https://img.shields.io/github/license/halo-dev/halo.svg?style=flat-square)](https://github.com/halo-dev/halo/blob/master/LICENSE)
> Halo 使用 GPL-v3.0 协议开源,请尽量遵守开源协议。
## 贡献
参考 [CONTRIBUTING](./CONTRIBUTING.md)。
## 捐赠
> 如果 Halo 对你有帮助,可以请开发团队们喝杯☕️。
- 一次性赞助:<https://sponsor.halo.run>
- 周期性赞助:<https://afdian.net/@halo-dev>
## 预览图
![theme-anatole.png](https://i.loli.net/2019/09/11/OQtKEWcCe8xYBph.png)
![theme-icarus.png](https://i.loli.net/2019/09/11/4lO2wNCLiqyIJmR.png)
![install.png](https://i.loli.net/2019/09/11/Iu1eMzZDg6frw97.png)
![admin-login.png](https://i.loli.net/2019/09/11/3CahVJAvXngwiQu.png)
![admin-dashboard.png](https://i.loli.net/2019/09/11/G5R6bOweYoiZKEv.png)
![admin-posts.png](https://i.loli.net/2019/09/11/uMHSeIkmC4iPzfJ.png)
![admin-post-edit.png](https://i.loli.net/2019/09/11/ucDh2tOZLJGTyHX.png)
![admin-post-publish.png](https://i.loli.net/2019/09/11/UwC3ecsRpAMONgq.png)
![admin-post-settings.png](https://i.loli.net/2019/09/11/bxmJ7OTirtvV4Gs.png)
![admin-attachment.png](https://i.loli.net/2019/09/11/B5UlX6vAgZ3bzaJ.png)
![admin-profile.png](https://i.loli.net/2019/09/11/mMageUXv5EDpfJQ.png)
![admin-themes.png](https://i.loli.net/2019/09/11/FVA953Ljswd4c8G.png)
![admin-options.png](https://i.loli.net/2019/09/11/TK6SeMdVj1xcrDw.png)