{"id":22287576,"url":"https://github.com/quickapps/docs","last_synced_at":"2025-07-07T19:16:04.067Z","repository":{"id":3176429,"uuid":"4207942","full_name":"quickapps/docs","owner":"quickapps","description":"QuickAppsCMS Official Documentation","archived":false,"fork":false,"pushed_at":"2018-04-05T11:55:01.000Z","size":1647,"stargazers_count":7,"open_issues_count":0,"forks_count":7,"subscribers_count":0,"default_branch":"2.x","last_synced_at":"2025-04-19T04:55:58.582Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.quickappscms.org/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quickapps.png","metadata":{"files":{"readme":"README.mdown","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-05-02T21:45:29.000Z","updated_at":"2018-04-05T11:55:03.000Z","dependencies_parsed_at":"2022-08-19T13:00:27.367Z","dependency_job_id":null,"html_url":"https://github.com/quickapps/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/quickapps/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickapps%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickapps%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickapps%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickapps%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quickapps","download_url":"https://codeload.github.com/quickapps/docs/tar.gz/refs/heads/2.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quickapps%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261058670,"owners_count":23103891,"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":[],"created_at":"2024-12-03T17:00:38.891Z","updated_at":"2025-06-21T03:38:39.115Z","avatar_url":"https://github.com/quickapps.png","language":"HTML","readme":"# QuickAppsCMS Official Documentation\r\n===================================\r\n\r\nWelcome to the official QuickApps CMS documentation. This manual assumes that you have a\r\ngeneral understanding of PHP and a basic understanding of object-oriented programming\r\n(OOP) and CakePHP framework.\r\n\r\n## Build the Documentation Manually\r\n\r\n### Installing the needed Packages\r\n\r\n- Make\r\n- Python\r\n- Sphinx 1.4.5\r\n- PhpDomain for sphinx \u003e= 0.2.0\r\n\r\nYou can install dependencies using:\r\n\r\n```bash\r\npip install -r requirements.txt\r\n```\r\n\r\n**To run the pip command, python-pip package must be previously installed.**\r\n\r\n### Building the Documentation\r\n\r\nAfter installing the required packages, you can build the documentation using `make`.\r\n\r\n```bash\r\n# Create all the HTML docs. Including all the languages.\r\nmake html\r\n\r\n# Create just the English HTML docs.\r\nmake html-en\r\n\r\n# Create all the EPUB (e-book) docs.\r\nmake epub\r\n\r\n# Create just the English EPUB docs.\r\nmake epub-en\r\n``` \r\n\r\nThis will generate all the documentation in an HTML form. Other output such as 'htmlhelp'\r\nare not fully complete at this time.\r\n\r\n### Building PDF Book\r\n\r\nBuilding the PDF is a non-trivial task.\r\n\r\n1. Install LaTeX - This varies by distribution/OS so refer to your package manager.\r\n   You should install the full LaTeX package.\r\n   The basic one requires many additional packages to be installed with `tlmgr`\r\n2. Run `make latex-en`\r\n2. Run `make pdf-en`\r\n\r\nAt this point the completed PDF should be in `_build/latex/en/QuickAppsCMSBook.pdf`\r\n\r\n## Contributing\r\n\r\nTo contribute simply fork the [official repository](https://github.com/quickapps/docs).\r\nPlease make any totally new sections in a separate branch. This makes changes far easier\r\nto integrate later on.\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquickapps%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquickapps%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquickapps%2Fdocs/lists"}