{"id":16817427,"url":"https://github.com/ssddanbrown/php-docs-builder","last_synced_at":"2025-11-06T03:30:25.913Z","repository":{"id":66363674,"uuid":"432868164","full_name":"ssddanbrown/PHP-Docs-Builder","owner":"ssddanbrown","description":"MIGRATED TO CODEBERG -- container to build and run a php/doc-lang repository.","archived":true,"fork":false,"pushed_at":"2023-11-22T02:34:08.000Z","size":20,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-10T20:32:57.650Z","etag":null,"topics":["container","docker","documentation","php"],"latest_commit_sha":null,"homepage":"https://codeberg.org/danb/PHP-Docs-Builder","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ssddanbrown.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":["ssddanbrown"],"ko_fi":"ssddanbrown"}},"created_at":"2021-11-29T01:22:21.000Z","updated_at":"2024-07-26T09:39:21.000Z","dependencies_parsed_at":"2023-11-22T03:28:51.831Z","dependency_job_id":"47fa134b-cb23-4aec-b5f1-a2540fd591ae","html_url":"https://github.com/ssddanbrown/PHP-Docs-Builder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssddanbrown%2FPHP-Docs-Builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssddanbrown%2FPHP-Docs-Builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssddanbrown%2FPHP-Docs-Builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssddanbrown%2FPHP-Docs-Builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ssddanbrown","download_url":"https://codeload.github.com/ssddanbrown/PHP-Docs-Builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239479570,"owners_count":19645763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["container","docker","documentation","php"],"created_at":"2024-10-13T10:47:10.288Z","updated_at":"2025-11-06T03:30:25.868Z","avatar_url":"https://github.com/ssddanbrown.png","language":"Shell","funding_links":["https://github.com/sponsors/ssddanbrown","https://ko-fi.com/ssddanbrown"],"categories":[],"sub_categories":[],"readme":"# PHP Docs Builder\n\nThe project provides a docker container which:\n\n- Has the dependencies to build the PHP documentation.\n- Builds source documentation into a php.net mirror.\n- Runs a development server hosting the php.net mirror.\n- Allows easy build/configure/render upon user command.\n\nThe process used by this container is based upon the process defined at http://doc.php.net/tutorial/local-setup.php.\n\n## Command Line Demo\n\n[![asciicast](https://asciinema.org/a/XNob6HPowsLWEgVsTyhkoSGVs.svg)](https://asciinema.org/a/XNob6HPowsLWEgVsTyhkoSGVs)\n\n## Usage\n\nThis container can be ran as per the example below, where `\u003cDOCS_REPO\u003e` is the path on your \nhost system that contains a `php/doc-\u003clang\u003e` repository instance ([English Example](https://github.com/php/doc-en)).\n\n```bash\ndocker run -itp 8080:8080 -v \u003cDOCS_REPO\u003e:/docs ghcr.io/ssddanbrown/php-docs-builder:latest\n```\n\nYou'd then be able to access the documentation via http://localhost:8080/manual/en.\n\nIf a volume is not mounted, or if the mounted `\u003cDOCS_REPO\u003e` is empty, then the repository for the \nconfigured language will be pulled down from GitHub on startup.\n\n#### Examples\n\nNote, You'll need to change any `/home/me` paths in examples below.\n\n**Getting started with the English docs**\n\n```bash\ngit clone https://github.com/php/doc-en.git /home/me/doc-en\ndocker run -itp 8080:8080 -v /home/me/doc-en:/docs ghcr.io/ssddanbrown/php-docs-builder:latest\n```\n\nThen open http://localhost:8080/manual/en in your browser to view.\n\n**Getting started with the Italian docs**\n\n```bash\ngit clone https://github.com/php/doc-it.git /home/me/doc-it\ndocker run -itp 8080:8080 -v /home/me/doc-it:/docs -e LANG=it ghcr.io/ssddanbrown/php-docs-builder:latest\n```\n\nThen open http://localhost:8080/manual/it in your browser to view.\n\n## Options\n\nThis container can take the following as ENV options:\n\n- `PORT` - (Integer) - Port to run the development webserver on. Defaults to `8080`.\n- `LANG` - (String)  - Lower case 2-character language code for the lang you want to work on. Defaults to `en`.\n\nNote: When using a non-en language, the latest en repository files will be pulled from GitHub on start-up\nto be used for building.\n\n## Contributing\n\nFeel free to raise any issues here on GitHub. Pull requests for fixes and patches are welcome.\nIf you're considering a PR to add a new feature or change please open an issue first for discussion to see if it's something that would be accepted.\nI generally want to keep the scope of this container focused to keep maintenance feasible.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssddanbrown%2Fphp-docs-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fssddanbrown%2Fphp-docs-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssddanbrown%2Fphp-docs-builder/lists"}