naala89/phpdoc-rsync repository overview

⁠naala89/phpdoc-rsync

This image generates a static PHPDOC site with the capability to upload to a remote location.

⁠Getting Started

These instructions will cover usage information and for the docker container

⁠Prerequisites

In order to run this container you'll need docker installed.

• Windows⁠
• OS X⁠
• Linux⁠

⁠Usage

⁠Environment Variables

None

⁠Volumes

• /app - Source markdown to be parsed by Bookdown.

⁠Useful File Locations

• /composer/vendor/bin/bookdown - Location of the bookdown binary.

⁠Example

Run interactively within the container.

docker run -it --rm -v .:/data naala89/apiopenstudio-bookdown:latest /bin/bash
$ /composer/vendor/bin/bookdown includes/wiki/bookdown.json /app/bookdown.json
$ rsync -rvI --delete --exclude=".*" "/site/" "user@my_site:/var/www/my_site"
$ ssh "user@my_site" "sudo chown -R www-data:www-data /var/www/my_site/*"

Run Bookdown within the container (no rsync)````

docker run --rm -v .:/app naala89/apiopenstudio-bookdown:latest

⁠Find Us

• GitLab⁠
• GitHub⁠
• www.apiopenstudio.com⁠

⁠Versioning

The unstable tags are tagged with the Gitlab Pipeline ID.

Version tags (i.e. phpdoc-rsync:3.1) references the phpdoc/phpdoc⁠ version.

The latest tag is master branch, his will be based on the most recent tag.

⁠Authors

• John Avery - John - GitLab⁠

⁠License

This project is licensed under the MIT License - see the LICENSE.md⁠ file for details.

⁠Acknowledgments

Many thanks to:

• The contributors to phpDocumentor⁠ for a great documenting tool
• The contributors to phpdoc/phpdoc⁠ for a great docker image.