{"id":34939021,"url":"https://github.com/phpnomad/documentation","last_synced_at":"2026-05-23T11:02:30.461Z","repository":{"id":263881753,"uuid":"879708657","full_name":"phpnomad/documentation","owner":"phpnomad","description":"Source for the PHPNomad documentation site at phpnomad.com — built with PHPNomad itself","archived":false,"fork":false,"pushed_at":"2026-04-14T03:10:49.000Z","size":1080,"stargazers_count":0,"open_issues_count":9,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-14T04:14:42.054Z","etag":null,"topics":["documentation","framework","php","phpnomad","platform-agnostic","static-site"],"latest_commit_sha":null,"homepage":"https://phpnomad.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phpnomad.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-10-28T12:13:44.000Z","updated_at":"2026-04-14T03:10:43.000Z","dependencies_parsed_at":"2026-01-22T06:08:34.209Z","dependency_job_id":null,"html_url":"https://github.com/phpnomad/documentation","commit_stats":null,"previous_names":["phpnomad/documentation"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/phpnomad/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpnomad%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpnomad%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpnomad%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpnomad%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phpnomad","download_url":"https://codeload.github.com/phpnomad/documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpnomad%2Fdocumentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33392816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-23T04:15:53.637Z","status":"ssl_error","status_checked_at":"2026-05-23T04:15:53.242Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","framework","php","phpnomad","platform-agnostic","static-site"],"created_at":"2025-12-26T18:49:43.738Z","updated_at":"2026-05-23T11:02:30.456Z","avatar_url":"https://github.com/phpnomad.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# phpnomad/documentation\n\nSource for the PHPNomad documentation site at [phpnomad.com](https://phpnomad.com). The docs site is itself a PHPNomad application, so the same framework the documentation describes is the framework rendering it. Markdown files in `public/docs/` are rendered through a Twig-backed MVC pipeline, served live during development or compiled to a static site for deployment.\n\n## What's in the repo\n\n- `index.php` is the dev server entry point. It boots the application in `dev()` mode and broadcasts a `RequestInitiated` event that flows through the router and controllers.\n- `generate.php` is the static compile CLI. It boots in `cli()` mode and broadcasts `StaticCompileInitiated` and `StaticCompileRequested` events that walk the docs tree and write HTML to disk.\n- `src/` holds the MVC source: the `Application` class, initializers, events, the `MarkdownController`, and the services that render Markdown and build navigation.\n- `public/` holds the Twig templates (`doc.twig`, `404.twig`, `layouts/`, `components/`), the site assets, and the `docs/` tree that holds the actual documentation content.\n\n## Running it locally\n\nInstall dependencies and start the dev server:\n\n```bash\ncomposer install\nphp -S localhost:8080 index.php\n```\n\nChanges to Markdown files are reflected on the next request. To compile the static site for deployment:\n\n```bash\nphp generate.php\n```\n\n## Configuration\n\nSite configuration lives in `configs/app.json`. Two keys matter: `docsRoot` (the directory holding your Markdown files, defaults to `public/docs`) and `templateRoot` (the directory holding the Twig templates, defaults to `public`).\n\n## Writing docs\n\nThe directory layout under `public/docs/` mirrors the URL structure. Subdirectories become path segments, and an `index.md` inside a directory becomes that directory's landing page. Links between documents work like regular Markdown links.\n\n## Contributing\n\nThis repository is the canonical place to propose changes to the PHPNomad documentation. The rendered output lives at [phpnomad.com](https://phpnomad.com).\n\n## License\n\nMIT. See [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpnomad%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphpnomad%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpnomad%2Fdocumentation/lists"}