danog/amp
1
0
Fork 0
mirror of https://github.com/danog/amp.git synced 2025-01-22 21:31:18 +01:00
Code Issues Projects Releases Wiki Activity
amp/docs
History
Niklas Keller 3a4c13ad9b Update shared documentation files 
This is an automated commit. Please report any issues to https://github.com/amphp/website-tools.
2020-08-30 21:22:25 +02:00
..
.shared @ a965e85928
Update shared documentation files
2020-08-30 21:22:25 +02:00
cancellation
Improve cancellation documentation to reflect the latest features
2017-05-27 19:46:14 +02:00
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
updated class spelling
2017-08-01 22:21:01 +02:00
_config.yml
Fix shared asset path for docs
2017-09-27 13:49:15 +02: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