{"id":17696818,"url":"https://github.com/datashaman/lowdown","last_synced_at":"2026-04-28T20:03:01.606Z","repository":{"id":56962861,"uuid":"186086813","full_name":"datashaman/lowdown","owner":"datashaman","description":"Documentation generator for PHP projects. WIP.","archived":false,"fork":false,"pushed_at":"2019-05-13T16:12:55.000Z","size":368,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-31T00:41:17.047Z","etag":null,"topics":["documentation","documentation-generator","reflection","vuejs"],"latest_commit_sha":null,"homepage":"","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/datashaman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-11T04:18:35.000Z","updated_at":"2019-05-13T16:12:57.000Z","dependencies_parsed_at":"2022-08-21T09:50:21.810Z","dependency_job_id":null,"html_url":"https://github.com/datashaman/lowdown","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/datashaman/lowdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datashaman%2Flowdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datashaman%2Flowdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datashaman%2Flowdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datashaman%2Flowdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datashaman","download_url":"https://codeload.github.com/datashaman/lowdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datashaman%2Flowdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32396781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T19:38:08.556Z","status":"ssl_error","status_checked_at":"2026-04-28T19:37:55.688Z","response_time":56,"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","documentation-generator","reflection","vuejs"],"created_at":"2024-10-24T14:45:26.239Z","updated_at":"2026-04-28T20:03:01.589Z","avatar_url":"https://github.com/datashaman.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lowdown\n\n**Lowdown** will generate documentation with as much detail as you provide in the form of type hints\nand PHPDoc annotations or _docblocks_ within your project.\n\nAll _docblocks_ are run through a _Markdown_ parser.\n\n**Lowdown** pays special attention to functions and methods which include a `\u003cpre\u003e\u003c/pre\u003e` block in the _docblock_.\n\nWhatever is within the `\u003cpre\u003e\u003c/pre\u003e` tag is deemed to be a code example.\n\nThe example is extracted and evaluated dynamically; the output is saved for inclusion in the documentation.\n\nTo further sweeten the deal, the example code can be posted to _GitHub_ as a gist.\n\nA link to run it as a [Melody](http://melody.sensiolabs.org) script is generated with the documentation.\n\n## install\n\nInstall the composer package into your project as a dev dependency:\n\n    composer require --dev datashaman/lowdown\n\n## configure\n\nAdd environment variables to your _.env_ to configure the build process. These are all optional.\n\n* `LOWDOWN_DEST`\n  The destination folder where documentation is written to. Defaults to _docs/api_.\n* `LOWDOWN_GISTS_CACHED`\n  _GitHub Gist_ requests should be cached. Defaults to _true_.\n* `LOWDOWN_GISTS_TOKEN`\n  _GitHub_ personal access token. Used for generating _Gists_.\n* `LOWDOWN_GISTS_USERNAME`\n  _GitHub_ username. Used for generating _Gists_.\n* `LOWDOWN_SOURCES`\n  The source folders where documentation is generated from. Comma-delimited. Defaults to _app,src_.\n* `LOWDOWN_WHITELIST`\n  Namespace whitelist. If set, documentation will be generated for only these namespaces. Comma-delimited.\n\n## build\n\nBuild your package's documentation:\n\n    lowdown build\n\nBuild your package's documentation with _Gists_ included:\n\n    lowdown build --gist\n\n## serve\n\nServe your package's documentation:\n\n    lowdown serve\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatashaman%2Flowdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatashaman%2Flowdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatashaman%2Flowdown/lists"}