{"id":44290909,"url":"https://github.com/mapitman/mdview","last_synced_at":"2026-02-10T23:34:14.604Z","repository":{"id":57530659,"uuid":"146152032","full_name":"mapitman/mdview","owner":"mapitman","description":"Convert markdown to HTML and launch it in a browser.","archived":false,"fork":false,"pushed_at":"2026-01-19T02:48:01.000Z","size":907,"stargazers_count":30,"open_issues_count":5,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-19T11:56:33.226Z","etag":null,"topics":["cli","golang","html","markdown"],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/mapitman.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-08-26T04:45:05.000Z","updated_at":"2026-01-19T02:47:04.000Z","dependencies_parsed_at":"2024-04-19T17:42:31.075Z","dependency_job_id":"979656b5-0b3a-4212-8313-49122035a88a","html_url":"https://github.com/mapitman/mdview","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/mapitman/mdview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapitman%2Fmdview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapitman%2Fmdview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapitman%2Fmdview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapitman%2Fmdview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mapitman","download_url":"https://codeload.github.com/mapitman/mdview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapitman%2Fmdview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29321425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-10T20:44:44.282Z","status":"ssl_error","status_checked_at":"2026-02-10T20:44:43.393Z","response_time":65,"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":["cli","golang","html","markdown"],"created_at":"2026-02-10T23:34:14.425Z","updated_at":"2026-02-10T23:34:14.587Z","avatar_url":"https://github.com/mapitman.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown View\n![Markdown View application icon showing the letter M with a downward arrow on a white background](markdown-256.webp)\n\n[![Build](https://github.com/mapitman/mdview/actions/workflows/build.yml/badge.svg)](https://github.com/mapitman/mdview/actions/workflows/build.yml)\n\nA lightweight command-line tool that converts markdown files to styled HTML and opens them in your default browser. Supports GitHub Flavored Markdown, Mermaid diagrams, embedded images, and automatic theme detection.\n\n## Features\n\n- **GitHub Flavored Markdown** - Full support for tables, task lists, strikethrough, and more\n- **Mermaid Diagrams** - Create flowcharts, sequence diagrams, state diagrams, and other visualizations directly in markdown\n- **Embedded Images** - Automatically converts relative image paths to data URIs for offline viewing\n- **Theme Detection** - HTML output conforms to your system's light or dark theme setting\n- **Typographic Enhancements** - Smart quotes, dashes, and other typographic improvements\n- **Bare HTML Option** - Generate unstyled HTML when needed\n- **Flexible Output** - Write to a temporary file or specify a custom output location\n\n\n\n## Usage\n\nBy default, `mdview` writes the generated HTML to a temporary directory.\nIt tries these in order:\n- A path defined in the `MDVIEW_DIR` environment variable\n- Your operating system's temporary directory\n\nIf you are on Linux and set the `TMPDIR` environment variable, that is \nwhat the OS will report as the temp directory. If you set it to a \ndirectory under your home directory, then browsers installed via Snap \n(like Firefox on Ubuntu) will be able to read the generated file.\nApplications installed via Snap are unable to read from `/tmp`.\n\n```text\nUsage:\nmdview [options] \u003cfilename\u003e\nFormats markdown and launches it in a browser.\nIf the environment variable MDVIEW_DIR is set, the temporary file will be written there.\n  -b Bare HTML with no style applied.\n  -bare\n     Bare HTML with no style applied.\n  -h Prints mdview help message.\n  -help\n     Prints mdview help message.\n  -o string\n     Output filename. (Optional)\n  -v Prints mdview version.\n  -version\n     Prints mdview version.\n\n```\n\nIf you do not supply an output file, mdview will write a file to your\noperating system's default temp directory or to the value of MDVIEW_DIR.\n\nThe generated HTML will conform to your system's light or dark theme\nsetting, as long as your browser supports that feature.\n\n### Thanks\n\nThanks to [sindresorhus](https://github.com/sindresorhus/github-markdown-css) for the GitHub style css.\n\n## Installation\n\n### Arch Linux (and derivatives)\n\nMarkdown View is available in the [AUR](https://aur.archlinux.org/packages/mdview/)\nIf you have an AUR helper like `yay`, installing is as easy as:\n```\nyay -S mdview\n```\n\n### Debian Package\n\nIf you're running Debian or a derivative like Ubuntu or Pop!_OS, you can\nuse [deb-get](https://github.com/wimpysworld/deb-get) to install mdview.\n\n```sh\ndeb-get install mdview\n```\n\nIf you don't want to use `deb-get`, you can download the package and\nmanually install it from the\n[Releases](https://github.com/mapitman/mdview/releases) page.\n\n```sh\ncurl -s https://api.github.com/repos/mapitman/mdview/releases/latest \\\n| grep \"browser_download_url.*amd64.deb\" \\\n| cut -d '\"' -f 4 \\\n| xargs curl -L -o mdview_lastest_amd64.deb\nsudo dpkg --install mdview_lastest_amd64.deb\n```\n\nTo remove the package:\n\n```sh\nsudo dpkg --remove mdview\n```\n\n### Snap Package\n\n_Update: The snap package has been fixed and the latest version is now available as a snap._ 🥳\n\nOn Linux, you can install [mdview](https://snapcraft.io/mdview) from the snap store. This option is only viable if the files\nyou want to view are in your home directory. If you need to view\nfiles in other locations, try an alternate installation method.\n\n_Note_: A side effect of the sandboxing of Snap packages is that every time\n`mdview` is executed, Snap will prompt to allow writing\nthe temporary file. If that is not acceptable, please choose an\nalternate installation method.\n\n[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/mdview)\n\n```sh\nsudo snap install mdview\n```\n\nDon't have snapd?  \n[Get set up for snaps](https://docs.snapcraft.io/core/install).\n\n### Manual Download and Install\n\nGrab the correct binary for your operating system\n[here](https://github.com/mapitman/mdview/releases/).\n\n### Compile Yourself\n\nIf you have Golang installed...\n```sh\ngo get github.com/mapitman/mdview\n```\n\nDon't have Golang? [Get it now](https://golang.org/doc/install).\n\n## How It Works\n\n```mermaid\ngraph TD\n    A[\"📄 Markdown File\"] --\u003e|Read| B[\"Process Images\"]\n    B --\u003e|Convert\u003cbr/\u003eRelative Paths\u003cbr/\u003eto Data URIs| C[\"Image Processing\"]\n    C --\u003e D[\"Parse Markdown\"]\n    D --\u003e|GFM + Mermaid\u003cbr/\u003e+ Typography| E[\"Goldmark Parser\"]\n    E --\u003e|Generate| F[\"HTML AST\"]\n    F --\u003e|Extract Title| G[\"Extract H1\"]\n    F --\u003e|Render| H[\"HTML Content\"]\n    H --\u003e|Embed\u003cbr/\u003eScripts| I[\"Add Mermaid.js\"]\n    I --\u003e|Apply Styles| J[\"Apply CSS Theme\"]\n    J --\u003e|Generate| K[\"HTML File\"]\n    K --\u003e|Launch| L[\"🌐 Browser\"]\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmapitman%2Fmdview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmapitman%2Fmdview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmapitman%2Fmdview/lists"}