You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
102 lines
3.7 KiB
102 lines
3.7 KiB
<img src="https://raw.githubusercontent.com/hexojs/logo/master/hexo-logo-avatar.png" alt="Hexo logo" width="100" height="100" align="right" /> |
|
|
|
# Hexo |
|
|
|
> A fast, simple & powerful blog framework, powered by [Node.js](https://nodejs.org). |
|
|
|
[Website](https://hexo.io) | |
|
[Documentation](https://hexo.io/docs/) | |
|
[Installation Guide](https://hexo.io/docs/#Installation) | |
|
[Contribution Guide](https://hexo.io/docs/contributing) | |
|
[Code of Conduct](CODE_OF_CONDUCT.md) | |
|
[API](https://hexo.io/api/) | |
|
[Twitter](https://twitter.com/hexojs) |
|
|
|
[![NPM version](https://badge.fury.io/js/hexo.svg)](https://www.npmjs.com/package/hexo) |
|
![Required Node version](https://img.shields.io/node/v/hexo) |
|
[![Build Status](https://github.com/hexojs/hexo/workflows/Tester/badge.svg)](https://github.com/hexojs/hexo/actions?query=workflow%3ATester) |
|
[![dependencies Status](https://img.shields.io/librariesio/release/npm/hexo)](https://libraries.io/npm/hexo) |
|
[![Coverage Status](https://coveralls.io/repos/hexojs/hexo/badge.svg?branch=master)](https://coveralls.io/r/hexojs/hexo?branch=master) |
|
[![Gitter](https://badges.gitter.im/hexojs/hexo.svg)](https://gitter.im/hexojs/hexo) |
|
[![Discord Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/teM2Anj) |
|
[![Telegram Chat](https://img.shields.io/badge/chat-on%20telegram-32afed.svg)](https://t.me/hexojs) |
|
[![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) |
|
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) |
|
|
|
## Features |
|
|
|
- Blazing fast generating |
|
- Support for GitHub Flavored Markdown and most Octopress plugins |
|
- One-command deploy to GitHub Pages, Heroku, etc. |
|
- Powerful API for limitless extensibility |
|
- Hundreds of [themes](https://hexo.io/themes/) & [plugins](https://hexo.io/plugins/) |
|
|
|
## Quick Start |
|
|
|
**Install Hexo** |
|
|
|
``` bash |
|
$ npm install hexo-cli -g |
|
``` |
|
|
|
Install with [brew](https://brew.sh/) on macOS and Linux: |
|
|
|
```bash |
|
$ brew install hexo |
|
``` |
|
|
|
**Setup your blog** |
|
|
|
``` bash |
|
$ hexo init blog |
|
$ cd blog |
|
``` |
|
|
|
**Start the server** |
|
|
|
``` bash |
|
$ hexo server |
|
``` |
|
|
|
**Create a new post** |
|
|
|
``` bash |
|
$ hexo new "Hello Hexo" |
|
``` |
|
|
|
**Generate static files** |
|
|
|
``` bash |
|
$ hexo generate |
|
``` |
|
|
|
## More Information |
|
|
|
- Read the [documentation](https://hexo.io/) |
|
- Visit the [Awesome Hexo](https://github.com/hexojs/awesome-hexo) list |
|
- Find solutions in [troubleshooting](https://hexo.io/docs/troubleshooting.html) |
|
- 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) |
|
- See the [plugin list](https://hexo.io/plugins/) and the [theme list](https://hexo.io/themes/) on wiki |
|
- Follow [@hexojs](https://twitter.com/hexojs) for latest news |
|
|
|
## Contributing |
|
|
|
We welcome you to join the development of Hexo. Please see [contributing document](https://hexo.io/docs/contributing). 🤗 |
|
|
|
Also, we welcome PR or issue to [official-plugins](https://github.com/hexojs). |
|
|
|
## Contributors |
|
|
|
[![](https://opencollective.com/Hexo/contributors.svg?width=890)](https://github.com/hexojs/hexo/graphs/contributors) |
|
|
|
## Backers |
|
|
|
[![Backers](https://opencollective.com/hexo/tiers/backers.svg?avatarHeight=36&width=600)](https://opencollective.com/hexo) |
|
|
|
## Sponsors |
|
|
|
<a href="https://linktr.ee/rss3"><img src="https://d1fdloi71mui9q.cloudfront.net/8xxahBqRTnecXgXKObeo_L8ks2KjC31fmM5Nd" alt="RSS3" width="200"/></a> |
|
|
|
## License |
|
|
|
[![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)
|
|
|