{"id":18320244,"url":"https://github.com/gedex/preview-github-readme.md","last_synced_at":"2025-04-05T22:31:48.645Z","repository":{"id":5137652,"uuid":"6304208","full_name":"gedex/preview-github-readme.md","owner":"gedex","description":"Preview your local github's Readme.md.","archived":false,"fork":false,"pushed_at":"2013-05-03T18:46:38.000Z","size":169,"stargazers_count":11,"open_issues_count":1,"forks_count":61,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-04T15:22:33.475Z","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":"dispatch/dispatch","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gedex.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":"2012-10-20T01:37:34.000Z","updated_at":"2023-04-08T17:12:34.000Z","dependencies_parsed_at":"2022-08-27T04:50:13.708Z","dependency_job_id":null,"html_url":"https://github.com/gedex/preview-github-readme.md","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gedex%2Fpreview-github-readme.md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gedex%2Fpreview-github-readme.md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gedex%2Fpreview-github-readme.md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gedex%2Fpreview-github-readme.md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gedex","download_url":"https://codeload.github.com/gedex/preview-github-readme.md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411237,"owners_count":20934650,"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-05T18:15:38.872Z","updated_at":"2025-04-05T22:31:48.345Z","avatar_url":"https://github.com/gedex.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Preview Github README.md\n========================\n\nThe preview mimics repo homepage in Github.\n\n## Requirements ##\n* PHP 5.3+\n* curl enabled\n* Internet connection to send POST request to Github API\n\n## How to use ##\nYou have project that need to be published onto Github and you're not\nsure about how the README.md will render in your repository's homepage.\n\n### Using CLI ###\n\n```\n$ ./preview_github_readme README.md\n```\n\nor you can pipe it to browser:\n\n```\n$ ./preview_github_readme README.md | browser\n````\n\nIn daily use, it's worth to alias this long script's name:\n\n```\nalias gmd='/path/to/cloned-repo/preview_github_readme'\n```\n\n### Using webserver ####\n\nAssuming your local development is accessible via `http://localhost/`\nand you're cloning this preview scripts into the docroot of your localhost.\nNow you can preview your local README.md:\n\n```\nhttp://localhost/preview_github_readme.php\n```\n\nor you can use PHP built-in server:\n\n```\nphp -S localhost:8080\n```\n\nand open above url with specified port.\n\n## How it Works\n\n`preview_github_readme.php` looks for readme file and\nif the file exists, send it to Github Markdown's API, otherwise lookup README.md,\nReadme.md, or readme.md file in root directory.\n\nThe markup and stylesheet for previewing are copied from Github.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgedex%2Fpreview-github-readme.md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgedex%2Fpreview-github-readme.md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgedex%2Fpreview-github-readme.md/lists"}