A simple development-time markdown to HTML renderer
npm install markdown-viewernpm install --save-dev markdown-viewer
/node_modules/.bin/markdown-viewer [OPTIONS]
--file, -r: markdown file path, relative to project root; defaults to README.md*
--output-dir, -o: output directory, relative to project root; defaults to .markdown-viewer*.
--open, -b: if set, opens the generated HTML in the default browser
--help, -h: show help document
$ /node_modules/.bin/markdown-viewer : generate README.html from README.md and output to .markdown-viewer/README.html
$ /node_modules/.bin/markdown-viewer --open : generate README.html, output to .markdown-viewer/README.html, and open in browser
$ /node_modules/.bin/markdown-viewer --file CONTRIBUTING.md --output-dir docs --open : generate CONTRIBUTING.html, output to docs/CONTRIBUTING.html, and open in browser
"view-readme": "./node_modules/.bin/markdown-viewer -b",
"view-contributing": "./node_modules/.bin/markdown-viewer -f CONTRIBUTING.md -b",
"view-license": "./node_modules/.bin/markdown-viewer -f LICENSE.md -b"
npm run view-readme to view the output of README.md
npm run view-contributing to view the output of the CONTRIBUTING.md file
npm run view-license to view the output of the LICENSE.md file