1
0
mirror of https://github.com/danog/amp.git synced 2024-12-11 17:09:40 +01:00
amp/docs
Niklas Keller 8f7300b1c3 Update shared documentation files
This is an automated commit. Please report any issues to https://github.com/amphp/website-tools.
2020-03-31 21:57:37 +02:00
..
.shared@30ac20c3b4 Update shared documentation files 2020-03-31 21:57:37 +02:00
cancellation
coroutines Update code style in docs 2018-06-18 20:11:15 +02:00
event-loop Add links to pecl and git repositories (#269) 2019-09-19 15:50:20 +02:00
images Fix arrow position in sequential-vs-concurrent.png 2019-09-22 13:38:53 +02:00
iterators Add toArray documentation (#286) 2019-10-11 20:30:42 +02:00
promises Fix syntax error in documentation example (#237) 2018-09-20 07:17:57 +02:00
utils
_config.yml
.gitignore Remove Gemfile.lock 2019-05-31 19:12:09 +02:00
asset
Gemfile
humans.txt
index.md Fix typo on homepage (#263) 2019-02-13 12:57:38 +01: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