README.md

   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 [Code of Conduct](CODE_OF_CONDUCT.md) |
  12 [API](https://hexo.io/api/) |
  13 [Twitter](https://twitter.com/hexojs)
  14
  15 [![NPM version](https://badge.fury.io/js/hexo.svg)](https://www.npmjs.com/package/hexo)
  16 ![Required Node version](https://img.shields.io/node/v/hexo)
  17 [![Build Status](https://github.com/hexojs/hexo/workflows/Tester/badge.svg)](https://github.com/hexojs/hexo/actions?query=workflow%3ATester)
  18 [![dependencies Status](https://img.shields.io/librariesio/release/npm/hexo)](https://libraries.io/npm/hexo)
  19 [![Coverage Status](https://coveralls.io/repos/hexojs/hexo/badge.svg?branch=master)](https://coveralls.io/r/hexojs/hexo?branch=master)
  20 [![Gitter](https://badges.gitter.im/hexojs/hexo.svg)](https://gitter.im/hexojs/hexo)
  21 [![Discord Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/teM2Anj)
  22 [![Telegram Chat](https://img.shields.io/badge/chat-on%20telegram-32afed.svg)](https://t.me/hexojs)
  23 [![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)
  24 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
  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 Install with [brew](https://brew.sh/) on macOS and Linux:
  43
  44 ```bash
  45 $ brew install hexo
  46 ```
  47
  48 **Setup your blog**
  49
  50 ``` bash
  51 $ hexo init blog
  52 $ cd blog
  53 ```
  54
  55 **Start the server**
  56
  57 ``` bash
  58 $ hexo server
  59 ```
  60
  61 **Create a new post**
  62
  63 ``` bash
  64 $ hexo new "Hello Hexo"
  65 ```
  66
  67 **Generate static files**
  68
  69 ``` bash
  70 $ hexo generate
  71 ```
  72
  73 ## More Information
  74
  75 - Read the [documentation](https://hexo.io/)
  76 - Visit the [Awesome Hexo](https://github.com/hexojs/awesome-hexo) list
  77 - Find solutions in [troubleshooting](https://hexo.io/docs/troubleshooting.html)
  78 - 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)
  79 - See the [plugin list](https://hexo.io/plugins/) and the [theme list](https://hexo.io/themes/) on wiki
  80 - Follow [@hexojs](https://twitter.com/hexojs) for latest news
  81
  82 ## Contributing
  83
  84 We welcome you to join the development of Hexo. Please see [contributing document](https://hexo.io/docs/contributing). 🤗
  85
  86 Also, we welcome PR or issue to [official-plugins](https://github.com/hexojs).
  87
  88 ## Contributors
  89
  90 [![](https://opencollective.com/Hexo/contributors.svg?width=890)](https://github.com/hexojs/hexo/graphs/contributors)
  91
  92 ## Backers
  93
  94 [![Backers](https://opencollective.com/hexo/tiers/backers.svg?avatarHeight=36&width=600)](https://opencollective.com/hexo)
  95
  96 ## Sponsors
  97
  98 [![Sponsors](https://opencollective.com/hexo/tiers/sponsors.svg?width=600)](https://opencollective.com/hexo)
  99
 100 ## License
 101
 102 [![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)