{"id":18814948,"url":"https://github.com/simplymichael/markdown-viewer","last_synced_at":"2026-04-13T17:03:31.049Z","repository":{"id":143889235,"uuid":"324114981","full_name":"simplymichael/markdown-viewer","owner":"simplymichael","description":"A simple development-time markdown to HTML renderer","archived":false,"fork":false,"pushed_at":"2020-12-24T10:00:08.000Z","size":89,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-08T09:45:37.930Z","etag":null,"topics":["contributing-md","license-md","markdown","markdown-viewer","readme-md"],"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/simplymichael.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-12-24T09:12:40.000Z","updated_at":"2020-12-24T10:00:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"d86a53b1-47b9-4cba-b3a2-c79ef769ad49","html_url":"https://github.com/simplymichael/markdown-viewer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplymichael%2Fmarkdown-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplymichael%2Fmarkdown-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplymichael%2Fmarkdown-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplymichael%2Fmarkdown-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplymichael","download_url":"https://codeload.github.com/simplymichael/markdown-viewer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239599081,"owners_count":19665911,"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":["contributing-md","license-md","markdown","markdown-viewer","readme-md"],"created_at":"2024-11-07T23:47:07.825Z","updated_at":"2026-01-13T09:30:17.540Z","avatar_url":"https://github.com/simplymichael.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Viewer\n[![Travis CI](https://img.shields.io/travis/com/simplymichael/markdown-viewer)](https://travis-ci.com/github/simplymichael/markdown-viewer)\n[![Codecov](https://img.shields.io/codecov/c/github/simplymichael/markdown-viewer)](https://codecov.io/gh/simplymichael/markdown-viewer)\n[![npm](https://img.shields.io/npm/dw/markdown-viewer)](https://npm.im/markdown-viewer)\n[![GitHub](https://img.shields.io/github/license/simplymichael/markdown-viewer)](https://github.com/simplymichael/markdown-viewer/LICENSE.md)\n\nA simple development-time markdown to HTML renderer.\n\nCheck that your markdown files (**README.md**, **LICENSE.md**, **CONTRIBUTING.md**)\nare properly constructed on your local machine,\nrather than waiting until you push to discover markdown errors.\n\n# Table of Contents\n\n- **[Installation](#installation)**\n- **[Features](#features)**\n- **[Usage](#usage)**\n    - **[Options](#options)**\n    - **[Examples](#examples)**\n    - **[Using NPM scripts](#using-npm-scripts)**\n\n## Installation\n`npm install --save-dev markdown-viewer`\n\n## Features\n\n- Generate HTML files (***.html***) from markdown (***.md***) files\n- Output generated HTML file to a default directory or specify a different output directory\n- Option to open the generated HTML in the browser immediately after generating it\n\n## Usage\n\n`\u003cproject_dir\u003e/node_modules/.bin/markdown-viewer [OPTIONS]`\n\n### Options\n\n* `--file`,       `-r`: markdown file path, relative to project root; defaults to ***README.md***\n* `--output-dir`, `-o`: output directory, relative to project root; defaults to ***.markdown-viewer***.\n  Make sure to add ***.markdown-viewer*** to your ***.gitignore*** and ***.npmignore*** files\n* `--open`,       `-b`: if set, opens the generated HTML in the default browser\n* `--help`,       `-h`: show help document\n\n### Examples\n\n- `$ \u003cproject_dir\u003e/node_modules/.bin/markdown-viewer`: generate **README.html** from **README.md** and output to ***.markdown-viewer/README.html***\n- `$ \u003cproject_dir\u003e/node_modules/.bin/markdown-viewer --open`: generate **README.html**, output to ***.markdown-viewer/README.html***, and open in browser\n- `$ \u003cproject_dir\u003e/node_modules/.bin/markdown-viewer --file CONTRIBUTING.md --output-dir docs --open`: generate **CONTRIBUTING.html**, output to ***docs/CONTRIBUTING.html***, and open in browser\n\n### Using NPM scripts\nYou can add the following stanzas to the *scripts* section of your ***package.json*** file:\n- `\"view-readme\": \"./node_modules/.bin/markdown-viewer -b\",`\n- `\"view-contributing\": \"./node_modules/.bin/markdown-viewer -f CONTRIBUTING.md -b\",`\n- `\"view-license\": \"./node_modules/.bin/markdown-viewer -f LICENSE.md -b\"`\n\nThen you can run:\n- `npm run view-readme` to view the output of *README.md*\n- `npm run view-contributing` to view the output of the *CONTRIBUTING.md* file\n- `npm run view-license` to view the output of the *LICENSE.md* file\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplymichael%2Fmarkdown-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplymichael%2Fmarkdown-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplymichael%2Fmarkdown-viewer/lists"}