Skip to content
/ mdp Public

mdp is a command-line tool that converts a Markdown file into HTML format that can be viewed in a browser.

Notifications You must be signed in to change notification settings

hayohtee/mdp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdp

mdp is a command-line tool that converts a Markdown file into HTML format that can be viewed in a browser.

Features

  • Convert Markdown file into HTML format
  • Sanitize the generated HTML document
  • Previewing the generated document in the browser.

Building from source

  1. Clone the repository
    git clone [email protected]:hayohtee/mdp.git
  2. Change into the project directory
    cd mdp
  3. Compile
    go build ./...

Usage

  1. Convert a Markdown
    To convert a and preview a markdown simply use the -file flag and specify the Markdown file that you want to convert
    Here is an example showing how to convert README.md file
    ./mdp -file README.md
  2. Disable auto preview
    By default mdp auto preview the generated HTML file in user's default program associated with HTML file.
    To disable this feature, include -s in addition to -file flag which skip autopreview.
    Here is an example showing how to convert README.md file while skipping auto preview
    ./mdp -file README.md -s
  3. Show all available options
    ./todo -h

About

mdp is a command-line tool that converts a Markdown file into HTML format that can be viewed in a browser.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages