user-documentation, 为那些使用HHVM和写入黑名称和PHP代码的HHVM编写文档 http

这是HHVM和 hack 用户文档文件的repo 。 欢迎使用贡献和反馈。

什么？

这里 repo 有三个键区域：

• 用户文档: 指南 。 我们意识到如何将HHVM设置为更复杂的事情，比如使用 async 更加繁琐。 文档应该是一个朋友，而不是麻烦。
• 的API参考: 我们使用自己的HHVM代码文档，针对 hack 和HHVM特定的API文档。 对于任何PHP特定的内容，我们都遵从 php.net 。 这有两个用途：
  • HHVM源代码是事实的来源。
  • PHP文档不会重复，而且它们的文档也会作为PHP特定文档的真实来源
• 基础架构: 更容易。更模块化和可以扩展的文档方式。 ，而不是 docbook，用于用户指南。 易于遵循，基于黑客的源代码，用于构建站点。

？

我们创建更好文档的策略开始于我们对文档基础结构的思考。

• Markdown 为文档源可读性和更新提供了一个更简单的路径。
  • 具有支持例如插入等内容的扩展。
• 标记扫描HHVM代码块文档( 而不是反射)，以便在更新文档时不需要重新生成 HHVM 。
  • 使用 phpDocumentor 进行docblock解析
• 确保构建站点的源代码尽可能重用，这样它就有可能为超出 hack 和HHVM的文档项目提供可以重用性。

查看源代码以生成站点。bin/build.php 是所有执行开始的地方。

正在运行本地副本

如果只希望快速运行副本，而不计划进行更改，请执行以下操作：

• 安装 Docker
• docker run -p 8080:80 -d hhvm/user-documentation ；这将输出一个容器标识
• 然后你可以访问 http://localhost:8080 文档的本地副本
• 若要停止实例，请运行 docker stop ID_FROM_STEP_2_ABOVE 。 如果你还没有该in的副本，请运行 docker ps，然后在右侧的最大列中使用容器 NAME 。

构建站点

如果你想在本地构建站点，你需要安装并配置你的系统，以便能够在本地构建和运行站点。

这些是基本的step-by-step指导，让你 and 。 它假定你的系统上安装了某些软件包。 在这里单击详细安装信息。

• 克隆这里存储库
• cd path/to/user-documentation
• git submodule update --init
• hhvm/path/to/composer.phar install # 确保已经下载了 Composer
• sudo gem install bundler 获取 ruby 包的#
• bundle --path vendor-rb/ # 安装需要 ruby 包
• hhvm bin/build.php # 构建站点 ！

从签出运行站点

将服务器和服务器配置为服务 public/ 目录，所有请求都不包含由 index.php 提供的文件。 对于本地开发，内置的hhvm web server应该足够了：

$ cd user-documentation/public
user-documentation/public$ hhvm -m server 
 -p 8080 
 -c.. /hhvm.dev.ini

提供内容

查看贡献指南。

你可以通过请求对该站点作出贡献。

跟随

跟随我们的进度。 我们从一开始就把这个 repo 打开了，你会看到我们第一次提交时发生的一切。

如果看到任何令人震惊的事情，可以在Freenode或者Facebook上的Freenode或者上为file文件issue