{"id":13570009,"url":"https://github.com/yusukebe/gh-markdown-preview","last_synced_at":"2025-05-15T15:06:29.369Z","repository":{"id":38824628,"uuid":"419946562","full_name":"yusukebe/gh-markdown-preview","owner":"yusukebe","description":"GitHub CLI extension to preview Markdown looks like GitHub.","archived":false,"fork":false,"pushed_at":"2025-01-25T14:00:10.000Z","size":442,"stargazers_count":560,"open_issues_count":7,"forks_count":27,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-07T21:09:44.737Z","etag":null,"topics":["cli","gh-extension","golang","markdown"],"latest_commit_sha":null,"homepage":"","language":"Go","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/yusukebe.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}},"created_at":"2021-10-22T02:55:13.000Z","updated_at":"2025-04-07T13:46:21.000Z","dependencies_parsed_at":"2024-08-04T15:28:43.069Z","dependency_job_id":"b91abd85-9a8b-4f43-a784-874a2d1242cc","html_url":"https://github.com/yusukebe/gh-markdown-preview","commit_stats":{"total_commits":71,"total_committers":8,"mean_commits":8.875,"dds":"0.12676056338028174","last_synced_commit":"b95fbe09a5d057493c951e92d859f24954330384"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Fgh-markdown-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Fgh-markdown-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Fgh-markdown-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Fgh-markdown-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yusukebe","download_url":"https://codeload.github.com/yusukebe/gh-markdown-preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254364270,"owners_count":22058878,"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":["cli","gh-extension","golang","markdown"],"created_at":"2024-08-01T14:00:47.123Z","updated_at":"2025-05-15T15:06:29.326Z","avatar_url":"https://github.com/yusukebe.png","language":"Go","readme":"# gh markdown-preview\n\nGitHub CLI extension to preview Markdown looks like GitHub :octocat:\n\n**gh markdown-preview** is a [GitHub CLI](https://cli.github.com) extension to preview your markdown such as **README.md**. The `gh markdown-preview` command start a local web server to serve the markdown document. **gh markdown-preview** renders the HTML got from GitHub official markdown API and uses the CSS extracted from GitHub web site. The styles are almost the same!\n\nYou can see rendered README before uploading to GitHub!\n\n## Features\n\n- **No-dependencies** - You need `gh` command only.\n- **Zero-configuration** - You don't have to set the GitHub access token.\n- **Looks exactly the same** - You can see same as GitHub.\n- **Live reloading** - You don't need reload the browser.\n- **Auto open browser** - Your browser will be opened automatically.\n- **Auto find port** - You don't need find an available port if default is used.\n\n## Screenshots\n\nOpen your browser:\n\n![Screenshot of gh markdown-preview](https://user-images.githubusercontent.com/10682/138411417-dd12a831-bacc-4b05-a33d-47d3f6b45483.png)\n\nLive reloading:\n\n![Screenshot of gh markdown-preview](https://user-images.githubusercontent.com/10682/138750423-ae7940cb-205e-4832-8e6a-af6f43c0f666.gif)\n\n## Installation\n\n```\ngh extension install yusukebe/gh-markdown-preview\n```\n\nUpgrade:\n\n```\ngh extension upgrade markdown-preview\n```\n\n## Usage\n\nThe usage:\n\n```\ngh markdown-preview README.md\n```\n\nOr this command will detect README file in the directory automatically.\n\n```\ngh markdown-preview\n```\n\nThen access the local web server such as `http://localhost:3333` with Chrome, Firefox, or Safari.\n\nAvailable options:\n\n```text\n    --dark-mode           Force dark mode\n    --markdown-mode       Force \"markdown\" mode (rather than default \"gfm\")\n    --disable-auto-open   Disable auto opening your browser\n    --disable-reload      Disable live reloading\n-h, --help                help for gh-markdown-preview\n    --host string         Hostname this server will bind (default \"localhost\")\n    --light-mode          Force light mode\n-p, --port int            TCP port number of this server (default 3333)\n    --verbose             Show verbose output\n    --version             Show the version\n```\n\n## Related projects\n\n- GitHub CLI \u003chttps://cli.github.com\u003e\n- Grip \u003chttps://github.com/joeyespo/grip\u003e\n- github-markdown-css \u003chttps://github.com/sindresorhus/github-markdown-css\u003e\n\n## Author\n\nYusuke Wada \u003chttp://github.com/yusukebe\u003e\n\n## License\n\nDistributed under the MIT License.\n","funding_links":[],"categories":["Go","⭐ Most Starred","cli","Tool"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusukebe%2Fgh-markdown-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyusukebe%2Fgh-markdown-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusukebe%2Fgh-markdown-preview/lists"}