• 开发
    • 开始之前
    • 工作流程
    • 注意事项
  • Updating official-plugins
  • 更新文档
    • 工作流程
    • 翻译
  • 反馈问题

    We welcome you to join the development of Hexo. ?

    开发

    我们非常欢迎您加入 Hexo 的开发,这份文件将帮助您了解开发流程。

    开始之前

    请遵守以下准则:

    • 遵守 Google JavaScript 代码风格。
    • 使用 2 个空格缩排。
    • 不要把逗号放在最前面。

    工作流程

    • Fork hexojs/hexo

    • 把库(repository)复制到电脑上,并安装所依赖的插件。

    1. $ git clone https://github.com/<username>/hexo.git
      $ cd hexo
      $ npm install
      $ git submodule update --init
    • 新增一个功能分支。
    1. $ git checkout -b new_feature
    • 开始开发。

    • 推送(push)分支。

    1. $ git push origin new_feature
    • 建立一个新的合并申请(pull request)并描述变动。

    注意事项

    • 不要修改 package.json 的版本号。

    • 只有在测试通过的情况下您的合并申请才会被批准,在提交前别忘了进行测试。

    1. $ npm test

    Updating official-plugins

    我们也欢迎给 Hexo 官方插件 提交 PR 和 Issue ?

    更新文档

    Hexo 文档开放源代码,您可以在 hexojs/site 找到源代码。

    工作流程

    • Fork hexojs/site

    • 把库(repository)复制到电脑上,并安装所依赖的插件。

    1. $ git clone https://github.com/<username>/site.git
      $ cd site
      $ npm install
    • 开始编辑文件,您可以通过服务器预览变动。
    1. $ hexo server
    • 推送(push)分支。

    • 建立一个新的合并申请(pull request)并描述变动。

    翻译

    • source 资料夹中建立一个新的语言资料夹(全小写)。
    • source 资料夹中相关的文件(Markdown 和模板文件)复制到新的语言资料夹中。
    • source/_data/language.yml 中新增语言。
    • en.yml 复制到 themes/navy/languages中并命名为语言名称(全小写)。

    反馈问题

    当您在使用 Hexo 时遇到问题,您可以尝试在 问题解答 中寻找解答,或是在 GitHub 或 Google Group 上提问。如果你没有找答案,请在 Github 报告它。

    • 在 调试模式 中重现问题。
    • 运行 hexo version 并检查版本信息。
    • 把调试信息和版本信息都贴到 GitHub。