1 | <img src="https://raw.githubusercontent.com/hexojs/logo/master/hexo-logo-avatar.png" alt="Hexo logo" width="100" height="100" align="right" />
|
2 |
|
3 | # Hexo
|
4 |
|
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 |
|
14 | [![NPM version](https://badge.fury.io/js/hexo.svg)](https://www.npmjs.com/package/hexo)
|
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)
|
18 | [![dependencies Status](https://david-dm.org/hexojs/hexo/status.svg)](https://david-dm.org/hexojs/hexo)
|
19 | [![devDependencies Status](https://david-dm.org/hexojs/hexo/dev-status.svg)](https://david-dm.org/hexojs/hexo?type=dev)
|
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)
|
24 | [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fhexojs%2Fhexo.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fhexojs%2Fhexo?ref=badge_shield)
|
25 |
|
26 | ## Features
|
27 |
|
28 | - Blazing fast generating
|
29 | - Support for GitHub Flavored Markdown and most Octopress plugins
|
30 | - One-command deploy to GitHub Pages, Heroku, etc.
|
31 | - Powerful API for limitless extensibility
|
32 | - Hundreds of [themes](https://hexo.io/themes/) & [plugins](https://hexo.io/plugins/)
|
33 |
|
34 | ## Quick Start
|
35 |
|
36 | **Install Hexo**
|
37 |
|
38 | ``` bash
|
39 | $ npm install hexo-cli -g
|
40 | ```
|
41 |
|
42 | **Setup your blog**
|
43 |
|
44 | ``` bash
|
45 | $ hexo init blog
|
46 | $ cd blog
|
47 | ```
|
48 |
|
49 | **Start the server**
|
50 |
|
51 | ``` bash
|
52 | $ hexo server
|
53 | ```
|
54 |
|
55 | **Create a new post**
|
56 |
|
57 | ``` bash
|
58 | $ hexo new "Hello Hexo"
|
59 | ```
|
60 |
|
61 | **Generate static files**
|
62 |
|
63 | ``` bash
|
64 | $ hexo generate
|
65 | ```
|
66 |
|
67 | ## More Information
|
68 |
|
69 | - Read the [documentation](https://hexo.io/)
|
70 | - Visit the [Awesome Hexo](https://github.com/hexojs/awesome-hexo) list
|
71 | - Find solutions in [troubleshooting](https://hexo.io/docs/troubleshooting.html)
|
72 | - 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)
|
73 | - See the [plugin list](https://hexo.io/plugins/) and the [theme list](https://hexo.io/themes/) on wiki
|
74 | - Follow [@hexojs](https://twitter.com/hexojs) for latest news
|
75 |
|
76 | ## Contributing
|
77 |
|
78 | We welcome you to join the development of Hexo. Please see [contributing document](https://hexo.io/docs/contributing). 🤗
|
79 |
|
80 | Also, we welcome PR or issue to [official-plugins](https://github.com/hexojs).
|
81 |
|
82 | ## Contributors
|
83 |
|
84 | [![](https://opencollective.com/Hexo/contributors.svg?width=890)](https://github.com/hexojs/hexo/graphs/contributors)
|
85 |
|
86 | ## Backers
|
87 |
|
88 | [![Backers](https://opencollective.com/hexo/tiers/backers.svg?avatarHeight=36&width=600)](https://opencollective.com/hexo)
|
89 |
|
90 | ## Sponsors
|
91 |
|
92 | <a href="https://www.jetbrains.com/"><img src="/.github/jetbrains-variant-4.svg" alt="JetBrains" width="200"/></a>
|
93 |
|
94 | <a href="https://www.cmscritic.com/"><img src="/.github/CMS-Critic_logo-3.png" alt="CMS Critic" width="200"/></a>
|
95 |
|
96 | <a href="https://getform.io/"><img src="/.github/getform-logo.svg" alt="Getform" width="200"/></a>
|
97 |
|
98 | ## License
|
99 |
|
100 | [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fhexojs%2Fhexo.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fhexojs%2Fhexo?ref=badge_large)
|