{"id":15630417,"url":"https://github.com/augustohp/shell-preview-markdown","last_synced_at":"2026-01-19T09:01:17.855Z","repository":{"id":137558874,"uuid":"195119964","full_name":"augustohp/shell-preview-markdown","owner":"augustohp","description":"Quickly preview your markdown with sensible defaults","archived":false,"fork":false,"pushed_at":"2019-07-03T20:24:11.000Z","size":7,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T23:34:25.794Z","etag":null,"topics":["markdown","posix-compliant","shell"],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/augustohp.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":"2019-07-03T20:07:45.000Z","updated_at":"2023-03-05T02:19:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"0390fd0f-c9a9-4c40-adc1-9ab75575b234","html_url":"https://github.com/augustohp/shell-preview-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/augustohp/shell-preview-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augustohp%2Fshell-preview-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augustohp%2Fshell-preview-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augustohp%2Fshell-preview-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augustohp%2Fshell-preview-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/augustohp","download_url":"https://codeload.github.com/augustohp/shell-preview-markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augustohp%2Fshell-preview-markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28565001,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T08:53:44.001Z","status":"ssl_error","status_checked_at":"2026-01-19T08:52:40.245Z","response_time":67,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["markdown","posix-compliant","shell"],"created_at":"2024-10-03T10:32:38.054Z","updated_at":"2026-01-19T09:01:17.835Z","avatar_url":"https://github.com/augustohp.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Preview Markdown files from the Shell\n\nHow is your markdown file going to be rendered? This receives a file and opens\nit in a browser for you.\n\n    $ preview-markdown --from README.md\n    /tmp/markdown-preview_README.html\n    $ preview-markdown --output email.rtf --from email.md\n    email.rtf\n\nThe output of the program is always the file generated for preview. By default,\na browser is opened - if [Lynx][] is present we prefer it. HTML is preferred as\nwell, but any format supported by [Pandoc][] can be used as output - use file\nextensions to denote them.\n\n    Usage: preview-markdown [options]\n           preview-markdown --from README.md\n           preview-markdown --from letter.md --output letter.pdf\n\n    Will generate an HTML preview of a markfown \u003cfile\u003e and open it inside a\n    browser (Lynx if existing).\n\n    Options:\n        -f \u003cpath\u003e, --from       The markdown file to generate a preview from.\n                                Default: README.md\n        -o \u003cpath\u003e, --output     The output file which will hold the preview.\n        -b, --browser           Prefer a real browser (e.g: Firefox) instead of\n                                Lynx (if it is available).\n        -j, --just-preview      Avoids opening the browser, just generates the\n                                preview file as HTML.\n        -v, --version           Prints version of the program.\n        -h, --help              This help message.\n    Environment variables:\n        PM_CSS_URL              The CSS file to be used for the rendered mardown.\n                                Default: GitHub markdown style\n        PM_MARKDOWN_EXTENSION   File extension to remove from the generated\n                                preview file.\n                                Default: md\n        PM_DEFAULT_INPUT        If no options are passed, which file should be\n                                used as input?\n                                Default: README.md\n\n    Report issues on https://github.com/augustohp/preview-markdown.\n    Contact me over augusto.hp [at] gmail [dot] com.\n\n## Installation\n\nYou can put the single file `preview-markdown` inside your *BIN* directories or\ndeclare a new `PATH` to where it is. If you want this easy, you can also use the\nline below:\n\n    sh \u003c(curl -sSL http://git.io/sinister) -u https://github.com/augustohp/shell-preview-markdown/raw/master/preview-markdown\n\nWhen you execute this, [Pandoc][] may be installed in the first execution.\ncommand - only supported on OSX.\n\n## LICENSE\n\nMIT\n\n[Lynx]: http://lynx.browser.org/ \"Lynx text browser\"\n[Pandoc]: http://pandoc.org/ \"A universal document converter\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugustohp%2Fshell-preview-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faugustohp%2Fshell-preview-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugustohp%2Fshell-preview-markdown/lists"}