1
0
mirror of https://github.com/danog/amp.git synced 2024-12-02 17:37:50 +01:00
amp/docs
2021-12-02 22:29:45 +01:00
..
.shared@a965e85928 Update shared documentation files 2020-08-30 21:22:25 +02:00
cancellation
coroutines
event-loop
images
iterators Add toArray documentation (#286) 2019-10-11 20:30:42 +02:00
promises Rename Deferred to DeferredFuture 2021-12-02 22:29:45 +01:00
utils
_config.yml
.gitignore
asset
Gemfile
humans.txt
index.md
README.md

Documentation

This directory contains the documentation for amphp/amp. Documentation and code are bundled within a single repository for easier maintenance. Additionally, this preserves the documentation for older versions.

Reading

You can read this documentation either directly on GitHub or on our website. While the website will always contain the latest version, viewing on GitHub also works with older versions.

Writing

Our documentation is built using Jekyll.

sudo gem install bundler jekyll
bundle install --path vendor/bundle
bundle exec jekyll serve