{"id":18929687,"url":"https://github.com/thecodingmachine/services.package-website-generator","last_synced_at":"2026-03-16T16:30:17.742Z","repository":{"id":6630356,"uuid":"7874239","full_name":"thecodingmachine/services.package-website-generator","owner":"thecodingmachine","description":"This is a website that generates documentation for your PHP packages hosted on packagist.org.","archived":false,"fork":false,"pushed_at":"2016-07-26T09:19:46.000Z","size":512,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"1.0","last_synced_at":"2025-02-16T12:30:29.636Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/thecodingmachine.png","metadata":{"files":{"readme":"README.md","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":"2013-01-28T16:54:36.000Z","updated_at":"2014-06-10T14:13:19.000Z","dependencies_parsed_at":"2022-08-24T01:31:28.927Z","dependency_job_id":null,"html_url":"https://github.com/thecodingmachine/services.package-website-generator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodingmachine%2Fservices.package-website-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodingmachine%2Fservices.package-website-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodingmachine%2Fservices.package-website-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodingmachine%2Fservices.package-website-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecodingmachine","download_url":"https://codeload.github.com/thecodingmachine/services.package-website-generator/tar.gz/refs/heads/1.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239927825,"owners_count":19719835,"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-11-08T11:34:25.990Z","updated_at":"2026-03-16T16:30:17.696Z","avatar_url":"https://github.com/thecodingmachine.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Composer packages documentation generator\n=========================================\n\nThis project is used to **generate a simple documentation website for your composer packages**.\n\nDemo\n----\n\nWant to see a sample? We use it at TheCodingMachine to generate the documentation of the [Mouf framework](http://mouf-php.com/packages/).\n\nYou can download and use this webapp for your own project too.\n\nHow does it work?\n-----------------\n\nYou configure the webapp with your packagist user name. A \"cron\" task runs every night. \nIt will check on [packagist.org](http://packagist.org) to see if there are new packages\nor new versions of some packages available. If so, it will download the package and generate a mini website\ncontaining the README, plus any other documentation files from your package if they have been declared in _composer.json_.\n\nDocumentation files must be declared in _composer.json_ according to the **Mouf's documentation syntax**:\n\n\t{\n\t    ...\n\t    \"extra\": {\n\t\t    \"mouf\": {\n\t\t    \t\"logo\": \"logo.png\",\n\t\t    \t\"doc\": [\n\t\t    \t\t{\n\t\t    \t\t\t\"title\": \"Introduction\",\n\t\t    \t\t\t\"url\": \"doc/introduction.html\"\n\t\t    \t\t},\n\t\t    \t\t{\n\t\t    \t\t\t\"title\": \"My first page\",\n\t\t    \t\t\t\"url\": \"doc/first_page.md\"\n\t\t    \t\t},\n\t\t    \t\t{\n\t\t    \t\t\t\"title\": \"My first chapter\",\n\t\t    \t\t\t\"url\": \"doc/chapter.html\"\n\t\t    \t\t\t\"children\": [\n\t\t\t    \t\t\t{\n\t\t\t\t    \t\t\t\"title\": \"A sub page\",\n\t\t\t\t    \t\t\t\"url\": \"doc/subpage.md\"\n\t\t\t    \t\t\t}\n\t\t    \t\t\t]\n\t\t    \t\t}\n\t\t    \t]\n\t\t    \t\n\t\t    }\n\t\t}\n\t}\n\nAs you can see, you can also provide a logo (as a 64x64 image).\nThe documentation can be provided in HTML or Markdown format.\n\nInstallation\n------------\n\nInstallation is done like any Mouf project:\n- **clone the repository** in your web directory\n- run **php composer.phar install** to install the environment\n- from your browser, **browse to**: http://[yourserver]/[apppath]/vendor/mouf/mouf\n- follow the **Mouf install procedure**\n- log into Mouf, and **edit the configuration**\n- at the root of your project, edit the .htaccess file and comment this line:\n\n```\n#RewriteCond %{REQUEST_FILENAME} !-d\n```\n\nA few things you might like to note:\n- in the configuration file, you specify your packagist's username. All your packages will be available in the application.\n- in the configuration file, you can provide a list of \"starred\" projects. On the homepage of your site, the starred projects will be highlighted.\n- you don't need a database (at least in the current version!) The website directly runs from the files.\n\nFinally, **install a cron task** that will periodically check packagist to see if there are new modules to install.\nThe command to run is:\n\tphp [path_to_app]/scripts/getPackagistProjects.php\n\t\nOf course, you will need to **run this script at least once** before your packages' documentation is available.\n\nWork in progress\n----------------\n\nYou are currently looking at a very early release of Composer Package Website Generator.\nThere are a number of things remaining to do:\n- add a cache system (the current version might not support a very high load)\n- add a search engine\n- and much more...\n\nIf you are interested in the development or want to help, do not hesitate to send me a mail: d.negrier at thecodingmachine.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecodingmachine%2Fservices.package-website-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecodingmachine%2Fservices.package-website-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecodingmachine%2Fservices.package-website-generator/lists"}