/github-readme-to-html

NPM module to convert GitHub markdown to HTML with GitHub-like styling and static assets. Output is ready to serve via static file hosting like Netlify with a push of a button.

Primary LanguageHTMLMIT LicenseMIT

GitHub Readme to HTML Static Site

NPM module to convert GitHub markdown to HTML with GitHub-like styling and static assets. Output is ready to serve via static file hosting like Netlify with a push of a button.

Install

npm install github-readme-to-html

Run

Usage: npx github-readme-to-html [options]

Options:
  -i, --input <filename>   The input readme/markdown file (default: "README.md")
  -o, --output <filename>  The output HTML file (default: "index.html")
  -t, --title <title>      The page title (default: "Read Me")
  -h, --help               display help for command

Output

All output goes to ./dist

- dist/
  - index.html
  - assets/
    - .
    - .
    - .

Example

Input: ORIGINAL.md

Output: https://github-readme-to-html.netlify.app/

This project is based on https://github.com/KrauseFx/markdown-to-html-github-style