{"id":29017869,"url":"https://github.com/cakephp/docs","last_synced_at":"2025-06-25T23:07:19.346Z","repository":{"id":820603,"uuid":"1514950","full_name":"cakephp/docs","owner":"cakephp","description":"CakePHP CookBook","archived":false,"fork":false,"pushed_at":"2025-06-18T07:23:15.000Z","size":76832,"stargazers_count":684,"open_issues_count":5,"forks_count":2574,"subscribers_count":70,"default_branch":"5.x","last_synced_at":"2025-06-18T08:27:38.896Z","etag":null,"topics":["cakephp","documentation","hacktoberfest"],"latest_commit_sha":null,"homepage":"http://book.cakephp.org","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cakephp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2011-03-23T04:54:13.000Z","updated_at":"2025-06-10T22:16:02.000Z","dependencies_parsed_at":"2023-09-24T11:10:36.717Z","dependency_job_id":"9c01059b-e87f-4af9-ad77-8eb36997b9ba","html_url":"https://github.com/cakephp/docs","commit_stats":{"total_commits":14759,"total_committers":1166,"mean_commits":"12.657804459691253","dds":0.7968019513517176,"last_synced_commit":"11e02f4c410ceff01b96b9301824a04cccfbb7f2"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cakephp/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cakephp","download_url":"https://codeload.github.com/cakephp/docs/tar.gz/refs/heads/5.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261967132,"owners_count":23237663,"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":["cakephp","documentation","hacktoberfest"],"created_at":"2025-06-25T23:07:17.425Z","updated_at":"2025-06-25T23:07:19.334Z","avatar_url":"https://github.com/cakephp.png","language":"Makefile","readme":"CakePHP Documentation\n=====================\n\n[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgreen.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)\n[![Build Status](https://github.com/cakephp/docs/actions/workflows/ci.yml/badge.svg?branch=4.x)](https://github.com/cakephp/docs/actions/workflows/ci.yml)\n\nThis is the official documentation for the CakePHP project. It is available\nonline in HTML, PDF and EPUB formats at https://book.cakephp.org.\n\nContributing to the documentation is pretty simple. Please read the\ndocumentation on contributing to the documentation over on [the\ncookbook](https://book.cakephp.org/5/en/contributing/documentation.html) for\nhelp. You can read all the documentation within as it is just in plain text\nfiles, marked up with ReST text formatting.\n\nThere are two ways for building the documentation: with Docker, or by installing\nthe packages directly on your OS.\n\nBuild the Documentation with Docker\n-----------------------------------\n\nDocker will let you create a container with all packages needed to build the\ndocs. You need to have docker installed, see the [official docs of\ndocker](https://docs.docker.com/desktop/) for more information.\n\n### Build the image locally ###\n\nStarting in the top-level directory, you can build the provided `Dockerfile`\nand tag it with the name `cakephp/docs` by running:\n\n```bash\ndocker build -t cakephp/docs .\n```\n\nThis can take a little while, because all packages needs to be downloaded, but\nyou'll only need to do this once.\n\nNow that the image is built, you can run all the commands to build the docs:\n\n##### To build the html: #####\n```bash\ndocker run -it --rm -v $(pwd):/data cakephp/docs make html\n```\n##### To build the epub: #####\n```bash\ndocker run -it --rm -v $(pwd):/data cakephp/docs make epub\n```\n##### To build the latex: #####\n```bash\ndocker run -it --rm -v $(pwd):/data cakephp/docs make latex\n```\n##### To build the pdf: #####\n```bash\ndocker run -it --rm -v $(pwd):/data cakephp/docs make pdf\n```\n\nAll the documentation will output to the `build` directory.\n\nBuild the Documentation Manually\n--------------------------------\n\n### Installing the needed Packages ###\n\nTo build the documentation you'll need to install dependencies using:\n\n```bash\npip install -r requirements.txt\n```\n\n*To run the pip command, python-pip package must be previously installed.*\n\n### Building the Documentation ###\n\nAfter installing the required packages, you can build the documentation using\n`make`.\n\n##### Create all the HTML docs. Including all the languages: #####\n```bash\nmake html\n```\n ##### Create just the English HTML docs: #####\n```bash\nmake html-en\n```\n\n##### Create all the EPUB (e-book) docs: #####\n```bash\nmake epub\n```\n##### Create just the English EPUB docs: #####\n```bash\nmake epub-en\n```\n\nAfter making changes to the documentation, you can build the HTML version of the\ndocs by using `make html` again.  This will build only the HTML files that have\nhad changes made to them.\n\n### Building the PDF ###\n\nBuilding the PDF is a non-trivial task.\n\n1. Install LaTeX - This varies by distribution/OS so refer to your package\n   manager. You should install the full LaTeX package. The basic one requires\n   any additional packages to be installed with `tlmgr`\n2. Run `make latex-en`.\n3. Run `make pdf-en`.\n\nAt this point the completed PDF should be in `build/latex/en/CakePHPBook.pdf`.\n\nContributing\n------------\n\nThere are currently a number of outstanding issues that need to be addressed.\nWe've tried to flag these with `.. todo::` where possible. To see all the\noutstanding todo's add the following to your `config/all.py`\n\n```python\ntodo_include_todos = True\n```\nAfter rebuilding the HTML content, you should see a list of existing todo items\nat the bottom of the table of contents.\n\nYou are also welcome to make and suggestions for new content as commits in a\nGitHub fork. Please make any totally new sections in a separate branch. This\nmakes changes far easier to integrate later on.\n\nTranslations\n------------\n\nContributing translations requires that you make a new directory using the two\nletter name for your language. As content is translated, directories mirroring\nthe English content should be created with localized content. For more info,\nplease,\n[click here](https://book.cakephp.org/3/en/contributing/documentation.html#new-translation-language).\n\nMaking Search Work Locally\n--------------------------\n\n* Install elasticsearch. This varies based on your platform, but most\n  package managers have a package for it.\n* Clone the [docs_search](https://github.com/cakephp/docs_search) into a\n  web accessible directory.\n* Modify `searchUrl` in `themes/cakephp/static/app.js` to point at the\n  baseurl for your docs_search clone.\n* Start elasticsearch with the default configuration.\n* Populate the search using tooling found in the [cakephp docs builder](https://github.com/cakephp/docs-builder) project.\n* You should now be able to search the docs using elasticsearch.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcakephp%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcakephp%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcakephp%2Fdocs/lists"}