{"id":13426554,"url":"https://github.com/yoshuawuyts/vmd","last_synced_at":"2026-04-04T03:37:04.378Z","repository":{"id":27012640,"uuid":"30476886","full_name":"yoshuawuyts/vmd","owner":"yoshuawuyts","description":":pray: preview markdown files","archived":false,"fork":false,"pushed_at":"2019-12-18T01:05:37.000Z","size":1111,"stargazers_count":1183,"open_issues_count":27,"forks_count":109,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-10-23T21:54:53.040Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/yoshuawuyts.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":"2015-02-08T01:28:58.000Z","updated_at":"2025-10-04T03:11:43.000Z","dependencies_parsed_at":"2022-07-11T19:50:35.935Z","dependency_job_id":null,"html_url":"https://github.com/yoshuawuyts/vmd","commit_stats":null,"previous_names":[],"tags_count":73,"template":false,"template_full_name":null,"purl":"pkg:github/yoshuawuyts/vmd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshuawuyts%2Fvmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshuawuyts%2Fvmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshuawuyts%2Fvmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshuawuyts%2Fvmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoshuawuyts","download_url":"https://codeload.github.com/yoshuawuyts/vmd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshuawuyts%2Fvmd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31387017,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T01:22:39.193Z","status":"online","status_checked_at":"2026-04-04T02:00:07.569Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-07-31T00:01:37.723Z","updated_at":"2026-04-04T03:37:04.355Z","avatar_url":"https://github.com/yoshuawuyts.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Apps"],"sub_categories":["Markdown","Open Source"],"readme":"# vmd\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![Downloads][downloads-image]][downloads-url]\n[![Codacy Badge][codacy-image]][codacy-url]\n\nPreview markdown files in a separate window. Markdown is formatted exactly the\nsame as on GitHub.\n\n[Features](#features) | [Installation](#installation) | [Usage](#usage) | [Examples](#examples) | [Command-line options](#options) | [Configuration](#configuration)\n\n![screenshot](https://raw.githubusercontent.com/yoshuawuyts/vmd/master/docs/screenshot.png)\n\n## Features\n\n - **GitHub style:** The markdown content is rendered as close to the way it's\n   rendered on GitHub as possible.\n\n - **File watching:** Local files opened in vmd are watched for changes and the\n   viewer will automatically update when a file has been changed. This makes it\n   ideal for writing documents in your favorite text editor and get a live\n   preview.\n\n - **Standard input:** View any markdown text from other programs by piping\n   another program's output in to vmd. Check out the [examples](#examples) for\n   cool use cases.\n\n - **Drag \u0026 Drop:** Drag files from your file browser or desktop on to a vmd\n   window and render it. Hold the `Shift` key while dropping to open the file\n   in a new window.\n\n - **Navigation:** Navigate within linked sections in a document, open relative\n   links to other documents in the same window or in a new one (`shift-click`),\n   and always be able to go back in the history. And open links to directories\n   in your file manager and external links in your default browser.\n\n - **Clipboard:** Copy links and local file paths to the clipboard, and even\n   copy images in binary format to paste them in to your image editing\n   software.\n\n - **Emoji:** :bowtie: Displays emoji, such as `:sweat_drops:`. Take a look at the\n   [Emoji Cheat Sheet][emoji-cheat-sheet] for a list of available emoji.\n\n - **Checklists:** Renders GitHub-style checklists.\n   ```\n    - [ ] List item 1\n    - [x] List item 2\n   ```\n    - [ ] List item 1\n    - [x] List item 2\n\n - **Search in page:** Search within your markdown file and scroll to the\n   results. Select \"Edit -\u003e Find\" from the menu or hit `Ctrl+F` (or `Cmd+F` on\n   OS X).\n\n - **Customization:** Select different themes and provide your own styles to\n   make vmd look the way you want. Take a look at the [Options](#options) for\n   an overview of available customization options.\n\n - **Front Matter**: Renders [Front Matter][frontmatter] in YAML and, if\n   enabled, in TOML and JSON so you can preview your Jekyll and Hugo content in\n   vmd. See some [examples][hugo-frontmatter].\n\n## Installation\n\n```bash\n$ npm install -g vmd\n```\n\n## Usage\n\n```\nvmd [FILE] [OPTIONS]\n```\n\nIf no FILE is provided it will try to read from standard input, or\nautomatically look for \"README.md\" if in a TTY.\n\n### Examples\n\nRead a file from disk:\n\n```sh\n$ vmd DOCUMENT.md\n```\n\nWhen no path to a document is supplied, \"README.md\" will be opened by default:\n\n```sh\n$ vmd\n```\n\nWhen a path to a directory is supplied, \"directory/README.md\" will be opened by default:\n\n```sh\n$ vmd node_modules/electron # opens node_modules/electron/README.md\n```\n\nIt reads from `stdin` so you can pipe markdown text in to it:\n\n```sh\n$ cat README.md | vmd\n```\n\nFor example, you can see the readme for [browserify](https://github.com/substack/node-browserify) like so:\n\n```sh\n$ npm view browserify readme | vmd\n```\n\nOr from a GitHub project:\n\n```sh\n$ gh-rtfm substack/node-browserify | vmd\n```\n\n### Options\n\n - `-v, --version`: Display the version number.\n\n - `--versions`: Display version numbers of different internal components such\n   as Electron.\n\n - `-h, --help`: Display usage instructions.\n\n - `-d, --devtools`: Open with the developer tools open.\n\n - `-z, --zoom=NUM`: Set a zoom factor to make the content larger or smaller.\n   For example `--zoom=1.25`\n\n - `--document=FILENAME`: vmd will look for \"README.md\" by default if no file\n   path has been specified. This can be changed to something else.\n\n - `--list-highlight-themes`: Display a list of available syntax highlighting\n   themes.\n\n - `--styles-main=FILE`: Provide a custom CSS file to display the content.\n\n - `--styles-extra=FILE`: Provide a custom CSS file to do additional styling.\n   For example to override some CSS properties fr the default style.\n\n - `--highlight-theme=NAME`: Use a different syntax highlighting theme for code\n   blocks. Run `vmd --list-highlight-themes` to get a list of available themes.\n\n - `--highlight-stylesheet=FILE`: Provide a custom CSS file for syntax\n   highlighting in code blocks.\n\n - `--window-preservestate=false`: By default vmd preserves the window state\n   for the next session, set this option to false to disable this.\n\n - `--window-autohidemenubar=true`: By default vmd always shows the menu bar.\n   To hide it set this flag to `true`. The menu visibility can be toggled using\n   the `Alt` key. Linux and Windows only.\n\n - `--frontmatter-formats=FORMATS`: A comma-separated list of Front Matter\n   formats. By default only the YAML format is enabled. Supported formats are\n   YAML, TOML and JSON.\n\n - `--frontmatter-renderer=RENDERER`: Specify how to render Front Matter. Can\n   be “table”, “code” or “none”. If “none” is specified the Front Matter will\n   not be rendered at all. Default is “table”.\n\n## Configuration\n\nAll [Options](#options) that contain a value can be persisted in configuration\nfile in INI, YAML or JSON format. The configuration file can be in any of the\nfollowing locations: `$HOME/.vmdrc`, `$HOME/.vmd/config`, `$HOME/.config/vmd`,\n`$HOME/.config/vmd/config`, `/etc/vmdrc`, or a custom location provided using\nthe `--config=FILE` option.\n\nIf you wish to change some of the default settings create a config file called\n`.vmdrc` in your home directory or in `~/.config/vmd`.\n\nHere's a sample config file:\n\n```ini\nzoom = 1.2\nhighlight.theme = monokai\nstyles.extra = /my/custom/vmd/style-fixes.css\n```\n\nOptions provided as command-line arguments will always have precedence over the\nvalues in the configuration file. So `--zoom=1.5` will set the zoom factor to\n1.5 regardless of what's in the config file.\n\n## Authors\n\n[Max Kueng](https://github.com/maxkueng), [Yoshua Wuyts](https://github.com/yoshuawuyts)\nand [contributors](https://github.com/yoshuawuyts/vmd/graphs/contributors).\n\n## License\n\n[MIT](https://tldrlegal.com/license/mit-license)\n\n[npm-image]: https://img.shields.io/npm/v/vmd.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/vmd\n[travis-image]: https://img.shields.io/travis/yoshuawuyts/vmd/master.svg?style=flat-square\n[travis-url]: https://travis-ci.org/yoshuawuyts/vmd\n[downloads-image]: http://img.shields.io/npm/dm/vmd.svg?style=flat-square\n[downloads-url]: https://npmjs.org/package/vmd\n[emoji-cheat-sheet]: http://www.emoji-cheat-sheet.com/\n[codacy-image]: https://img.shields.io/codacy/grade/ccaa489b6f664ebd9a12d900334be10f/master.svg?style=flat-square\n[codacy-url]: https://www.codacy.com/app/maxkueng/vmd?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=yoshuawuyts/vmd\u0026amp;utm_campaign=Badge_Grade\n[frontmatter]: https://jekyllrb.com/docs/frontmatter/\n[hugo-frontmatter]: https://gohugo.io/content-management/front-matter/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoshuawuyts%2Fvmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoshuawuyts%2Fvmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoshuawuyts%2Fvmd/lists"}