Download the PHP package facebook/hh-apidoc without Composer

On this page you can find all versions of the php package facebook/hh-apidoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package hh-apidoc

hh-apidoc

Continuous Integration

An API documentation generator for Hack files. The generator works on files that start with <?hh.

Example

HHAPIDoc generates its own API reference documentation.

Project status

This is derived from docs.hhvm.com's documentation generator, and has been in use there for several months.

As a standalone project, it is immature, and an early preview; work is needed on output format (prettiness), usability, and functionality. See the issues to get started. We welcome contributions.

Installing hh-apidoc

  1. Install hhvm
  2. Install composer
  3. Move composer.phar to your desired location. Many people put this in their home directory or a global bin directory.
  4. Clone this repo
  5. cd path/to/cloned/hh-apidoc
  6. hhvm path/to/composer.phar install
  7. Verify installation via hhvm bin/hh-apidoc --help. You should see usage instructions.

Testing hh-apidoc

Running hh-apidoc against itself is a good way to test the generator:

  1. hhvm bin/hh-apidoc -o /tmp/docs ./src The -o is where to output the resulting files (it is important to note that the path given to -o must currently be an existing path). . means use the current directory as the source.
  2. cd /tmp/docs
  3. See generated .html files. You can open index.html in your favorite browser to see the generated documentation.

License

hh-apidoc is MIT licensed, as found in the LICENSE file.

All versions of hh-apidoc with dependencies

PHP Build Version
Package Version
Requires hhvm Version ^4.102
hhvm/hsl Version ^4.0
hhvm/hsl-experimental Version ^4.53
facebook/fbmarkdown Version ^1.6.5
facebook/hh-clilib Version ^2.1.0
facebook/definition-finder Version ^2.13.0
hhvm/hhast Version ^4.80
hhvm/hsl-io Version ^0.2.1|^0.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package facebook/hh-apidoc contains the following files

Loading the files please wait ....