Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 1.08 KB

readme.md

File metadata and controls

26 lines (22 loc) · 1.08 KB
Raw

MarkDown Preview

MarkDown Preview toolmdp, that convert .md extension to .html extension that can be viewed in a browser

How? in four main steps:

  1. Read the content of the input Markdown file
  2. Use some Go external libraries to parse Markdown and generate valid HTML block
  3. Wrap the results with an HTML header and footers
  4. Save the buffer to an HTML file that you can view in a browser
  • Use the blackfriday pkg generate the content based on the input Markdown, but it doesn't include the HTML header and footer required to view it in a browser.
  • Use the bluemonday pkg to sanitize the html content to be valid and safe
    - go get github.com/russross/blackfriday/v2
    - go get github.com/microcosm-cc/bluemonday

use those commands to build and execute the tool:

  • preview file feature opening automatically in the browser using -f flag followed by file name.
  • use dynamic html title and body using -t followed by template file
$ go build -o mdp
$ ./mdp -file README.md -t template-fmt.html.tmpl

if you want to skip auto-previewing the html file use -s flag