Development

Hexo welcomes you to join the development of Hexo. This document will help you through the process.

Before You Start

Please follow the coding style:

• Follow Google JavaScript Style Guide.
• Use soft-tabs with a two space indent.
• Don’t put commas first.

Workflow

1. Fork the project.
2. Clone the repository to your computer and install dependencies.

$ git clone https://github.com/<username>/hexo.git
$ cd hexo
$ npm install
$ git submodule update --init

1. Create a feature branch for your change.

$ git checkout -b new_feature

1. Start hacking. Don’t forget to run tests.
2. Push the branch:

$ git push origin new_feature

1. Create a pull request against the master branch and describe the change.

Don't change version in package.json

When making changes on Hexo, don’t change version number in package.json.

Updating Documentation

The Hexo documentation is open source and you can find the source code on hexojs/site. To update the documentation:

1. Fork the project
2. Clone the repository to your computer and install dependencies.

$ git clone https://github.com/<username>/site.git
$ cd site
$ npm install

1. Start editing the documentation. You can start the server for live previewing.

$ hexo server

1. Push the branch:
2. Create a pull request against the master branch and describe the change.

Reporting Issues

When you encounter some problems when using Hexo, you can find the solutions in [Troubleshooting] or ask me on GitHub or Google Group. If you can’t find the answer, please report it on GitHub.

1. Represent the problem in debug mode.

$ hexo --debug

1. Check the version info.

$ hexo version

1. Post both debug message and version info on GitHub.