{"repo":"cakephp/docs","free":true,"listed":false,"github":"https://github.com/cakephp/docs","clone":"git clone https://github.com/cakephp/docs.git","description":"CakePHP CookBook","language":"JavaScript","stars":693,"topics":["cakephp","documentation","hacktoberfest"],"license":null,"category":"docs-static-sites","readme_excerpt":"CakePHP Documentation ===================== This is the official documentation for the CakePHP project. It is available online at https://book.cakephp.org. Contributing to the documentation is pretty simple. Please read the documentation on contributing to the documentation over on the cookbook for help. You can read all the documentation within as it is just in plain text files, marked up with Markdown formatting. Local Development Install dependencies, then start the VitePress development server: The documentation will be available at http://localhost:5173 with hot-reload enabled. Other Commands Prerequisites - node (version 22 or newer) - JavaScript runtime required by Vite/VitePress - npm - Package manager (included with most Node.js installations) - git - Required to install @cakephp/docs-skeleton from GitHub Build the Documentation with Docker Docker will let you create a container with all packages needed to build the docs. You need to have docker installed, see the official docs of docker for more information. Build the image locally Starting in the top-level directory, you can build the provided Dockerfile and tag it with the name cakephp/docs by running: This can take a little while, because all packages needs to be downloaded, but you'll only need to do this once. Now that the image is built, you can run the commands to build the docs: To build the static site: To run the development server: The built documentation will output to the .vitepress/dist directory. Cont","default_branch":null,"files":null,"tree":[],"storefront":"/r/cakephp","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/cakephp/docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}