1
0
mirror of https://github.com/danog/amp.git synced 2024-11-30 04:29:08 +01:00
amp/docs
2017-05-27 17:16:29 +02:00
..
cancellation Fix page titles to allow a menu 2017-05-26 21:13:34 +02:00
coroutines Fix page titles to allow a menu 2017-05-26 21:13:34 +02:00
event-loop Fix page titles to allow a menu 2017-05-26 21:13:34 +02:00
iterators Fix page titles to allow a menu 2017-05-26 21:13:34 +02:00
promises Improve promise documentation and document performance hack 2017-05-27 17:16:29 +02:00
shared@b41d62f7db Improve promise documentation and document performance hack 2017-05-27 17:16:29 +02:00
utils Fix page titles to allow a menu 2017-05-26 21:13:34 +02:00
_config.yml Order documentation menu 2017-05-27 10:48:04 +02:00
.gitignore Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00
Gemfile Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00
Gemfile.lock Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00
index.md Improve introduction 2017-05-26 21:42:33 +02:00
README.md Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00

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