{"id":13459068,"url":"https://github.com/aheckmann/greadme","last_synced_at":"2025-04-10T01:33:58.930Z","repository":{"id":4481249,"uuid":"5620276","full_name":"aheckmann/greadme","owner":"aheckmann","description":"Locally preview your markdown, Github style","archived":false,"fork":false,"pushed_at":"2024-05-02T02:02:32.000Z","size":342,"stargazers_count":77,"open_issues_count":2,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-24T03:11:55.590Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://aheckmann.github.com/greadme/","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/aheckmann.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","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":"2012-08-30T20:14:30.000Z","updated_at":"2024-12-15T15:03:34.000Z","dependencies_parsed_at":"2024-06-21T03:55:22.541Z","dependency_job_id":"fa7e535a-9fe6-408c-ae54-552fdc152cb2","html_url":"https://github.com/aheckmann/greadme","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aheckmann%2Fgreadme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aheckmann%2Fgreadme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aheckmann%2Fgreadme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aheckmann%2Fgreadme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aheckmann","download_url":"https://codeload.github.com/aheckmann/greadme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248140885,"owners_count":21054366,"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-07-31T09:01:02.641Z","updated_at":"2025-04-10T01:33:58.907Z","avatar_url":"https://github.com/aheckmann.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# greadme\n\nLocally preview your markdown, Github style.\n\n![](https://dl.dropboxusercontent.com/u/4034363/greadme.png)\n\n## Installation\n\nvia npm:\n\n    $ npm install -g greadme\n\n\n## Usage\n\n    $ greadme [path/to/some.markdown]\n\n       view your markdown at http://localhost:8124/\n       press CTRL+C to quit\n\nExecute `greadme` passing an optional path to a markdown file and it will be parsed and served from a locally running\nhttp server with Github styling applied. When no file path is specified, `greadme` displays a file browser of the\ncurrent directory, similar to Github.\n\n\nA browser will automatically be opened to preview the markdown if your OS supports it.\n\n\nFiles with the following extensions are rendered.\n\n- .md\n- .markdown\n\n\nThe default port is `8124` and the default host is `localhost`. You can change these settings by passing the `--port`\nand `--host` option. For example:\n\n\n    $ greadme --host 127.0.0.0 --port 7220\n\n\n## Notes\n\nAn attempt is made to use the [Github markdown rendering api](http://developer.github.com/v3/markdown/) and Githubs stylesheets. If the attempt fails we fall back to rendering locally.\n\n\n## Contributors\n\nhttps://github.com/aheckmann/greadme/graphs/contributors\n\n## License\n\n[MIT](https://github.com/aheckmann/greadme/blob/master/LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faheckmann%2Fgreadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faheckmann%2Fgreadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faheckmann%2Fgreadme/lists"}