{"id":14968637,"url":"https://github.com/theodorosploumis/php-docs","last_synced_at":"2025-08-16T12:10:45.311Z","repository":{"id":42428487,"uuid":"276925642","full_name":"theodorosploumis/php-docs","owner":"theodorosploumis","description":"A simple web tool to create html docs under git from structured markdown files.","archived":false,"fork":false,"pushed_at":"2024-07-06T11:52:15.000Z","size":15993,"stargazers_count":3,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-07T15:43:45.390Z","etag":null,"topics":["docs","documentation","drupal","drupal8","generator","hacktoberfest","jamstack","markdown","php"],"latest_commit_sha":null,"homepage":"https://theodorosploumis.github.io/php-docs/example.html","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/theodorosploumis.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-03T14:59:52.000Z","updated_at":"2024-07-06T11:52:13.000Z","dependencies_parsed_at":"2025-02-11T09:32:11.911Z","dependency_job_id":"f484a5ea-359e-4b0e-8ad4-dd1b3d72466a","html_url":"https://github.com/theodorosploumis/php-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/theodorosploumis/php-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fphp-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fphp-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fphp-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fphp-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theodorosploumis","download_url":"https://codeload.github.com/theodorosploumis/php-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fphp-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270709026,"owners_count":24631992,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docs","documentation","drupal","drupal8","generator","hacktoberfest","jamstack","markdown","php"],"created_at":"2024-09-24T13:40:20.208Z","updated_at":"2025-08-16T12:10:45.221Z","avatar_url":"https://github.com/theodorosploumis.png","language":"PHP","readme":"# PHP Documentation Generator\n\n## About\nA simple web tool to create html docs under git from structured markdown files.\n\nI use it to create Drupal manuals based on structure of \n[theodorosploumis/drupal-manual](https://github.com/theodorosploumis/drupal-manual).\n\n## Features\n- One page docs\n- HTML default output\n- Single pages option\n- Version control data\n- Structured data\n- Simple to install and start with\n- Custom css with css variables\n\n## Requirements\n- composer\n- php 7.1+\n\n## Libraries used\n- [spatie/yaml-front-matter](https://github.com/spatie/yaml-front-matter)\n- [league/commonmark](https://github.com/spatie/league/commonmark)\n- [tijsverkoyen/css-to-inline-styles](https://github.com/tijsverkoyen/css-to-inline-styles)\n- [dompdf/dompdf](https://github.com/dompdf/dompdf)\n\n\n## Structure\nNormally you should only add/edit files inside these folders.\n\n```\n// styling \u0026 helper images\ncss\n\n// md files and images that generate pages\ndata\n\n```\n\n## Run\n```\ncp settings.php.example settings.php\ncomposer install\nphp -S localhost:4777\n```\n\n## See also\n\n- [Drupal.org - User Guide project (asciidoc files)](https://www.drupal.org/project/user_guide)\n- [Drupal.org - User Guide PDF](https://www.drupal.org/docs/understanding-drupal/user-guide-e-book-downloads)\n\n## ToDo\n\n### php\n- document functions\n- use global settings inside md (eg site url)\n- create a function to generate Taxonomy pages or lists\n- livereload on every change\n- add html mask numbers (annotations) over images (?)\n\n### Fix dompdf\n- add page numbers\n- add page numbers to TOC\n\n### data\n- allow json data\n- add inline md editor\n- support Chrome workspaces (for editing)\n\n### export\n- support docx\n- support pdf (with css styles)\n- support json\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheodorosploumis%2Fphp-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheodorosploumis%2Fphp-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheodorosploumis%2Fphp-docs/lists"}