{"id":16402636,"url":"https://github.com/saltyshiomix/gfm-preview","last_synced_at":"2025-03-21T02:33:19.744Z","repository":{"id":49018292,"uuid":"143150795","full_name":"saltyshiomix/gfm-preview","owner":"saltyshiomix","description":"Preview your markdown with GitHub API in real time 🎉","archived":false,"fork":false,"pushed_at":"2024-01-10T09:36:39.000Z","size":280,"stargazers_count":19,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-12T05:46:49.330Z","etag":null,"topics":["gfm","javascript","markdown","markdown-previewer","nodejs"],"latest_commit_sha":null,"homepage":"https://npm.im/gfm-preview","language":"JavaScript","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/saltyshiomix.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}},"created_at":"2018-08-01T12:06:53.000Z","updated_at":"2022-12-14T22:52:02.000Z","dependencies_parsed_at":"2023-01-26T07:15:31.152Z","dependency_job_id":null,"html_url":"https://github.com/saltyshiomix/gfm-preview","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltyshiomix%2Fgfm-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltyshiomix%2Fgfm-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltyshiomix%2Fgfm-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltyshiomix%2Fgfm-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltyshiomix","download_url":"https://codeload.github.com/saltyshiomix/gfm-preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221811380,"owners_count":16884305,"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":["gfm","javascript","markdown","markdown-previewer","nodejs"],"created_at":"2024-10-11T05:46:49.102Z","updated_at":"2024-10-28T09:12:28.403Z","avatar_url":"https://github.com/saltyshiomix.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://www.npmjs.com/package/gfm-preview\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/gfm-preview.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/gfm-preview\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/gfm-preview.svg\"\u003e\u003c/a\u003e\n\n## Usage\n\n```bash\n# install it\n$ npm install --global gfm-preview\n\n# preview your markdown\n$ preview file.md\n\n# preview with firefox\n$ preview file.md --browser firefox\n\n# preview with chrome on macOS\n$ preview file.md --browser 'google chrome'\n\n# preview custom host and port number\n$ preview file.md --host yourhost --port 3333\n\n# preview with GitHub Enterprise API\n$ preview file.md --github-api-url https://your-ghe-host:port/api/v3\n```\n\n## Feature\n\n- Render your markdown with GitHub API\n- Launch a local preview server (`http://localhost:4649`)\n- Hot reload previews when detecting changes\n- Close the server when the preview is closed\n- Support GitHub Enterprise\n\n## How to change default browser\n\nThe browser name is platform dependent. For example, Chrome is `google chrome` on macOS, `google-chrome` on Linux and `chrome` on Windows.\n\n```bash\n# with chrome on macOS\n$ preview file.md --browser 'google chrome'\n\n# with a custom executable\n$ preview file.md --browser 'C:\\\\Program Files\\\\Mozilla Firefox\\\\firefox.exe'\n```\n\n## If you use GitHub Enterprise (GHE)\n\nAdd an alias to your `~./bashrc`:\n\n```bash\nalias preview='preview --github-api-url https://your-ghe-host:port/api/v3'\n```\n\nThen use it:\n\n```bash\n$ preview file.md\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltyshiomix%2Fgfm-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltyshiomix%2Fgfm-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltyshiomix%2Fgfm-preview/lists"}