danog/amp
1
0
Fork 0
mirror of https://github.com/danog/amp.git synced 2024-12-11 17:09:40 +01:00
Code Issues Projects Releases Wiki Activity
1a2be8f2b2
amp/docs
History
Niklas Keller d20f07acee Update cancellation docs
2021-12-02 23:45:45 +01:00
..
.shared@a965e85928 Update shared documentation files 2020-08-30 21:22:25 +02:00
cancellation Update cancellation docs 2021-12-02 23:45:45 +01:00
coroutines Update code style in docs 2018-06-18 20:11:15 +02:00
images Fix arrow position in sequential-vs-concurrent.png 2019-09-22 13:38:53 +02:00
promises Rename Deferred to DeferredFuture 2021-12-02 22:29:45 +01:00
_config.yml Remove outdated docs 2021-12-02 23:38:17 +01:00
.gitignore Remove Gemfile.lock 2019-05-31 19:12:09 +02:00
asset Update to new shared repository 2017-09-27 13:25:40 +02:00
Gemfile Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00
humans.txt Add humans.txt to website 2017-05-28 16:07:07 +02:00
index.md Fix typo on homepage (#263) 2019-02-13 12:57:38 +01:00
README.md Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00

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