Skip to content

seebe/md2html

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Markdown to HTML Converter

This script uses the standard 'markdown' application, but then makes additional changes to make the HTML look better.

Installation

  • Install the markdown application
$ sudo apt install markdown
  • Clone this repository
$ git clone https://github.com/seebe/md2html
  • Add an alias to your login script to make it easier to run.
$ cd md2html
$ echo "alias md2html='$PWD/md2html.sh'" >> ~/.bashrc
  • Note that after you add this alias, you will need to open a new terminal window for this to start working (because that is when .bashrc is read). This also means for any terminal window that currently open, this alias will not work yet. However, you can simply enter "source ~/.bashrc" in any open terminal window to re-read in your update bashrc file with your new alias.

Usage

  • Enter the filename of the .md file you would like to convert.
  • The output file .html will be created.
  • If no filename is passed, "README.md" will be assumed (since that file is common in github repositories)
 
$ md2html README.md

Notes

  • ★ Alwasy check your html file in the broswer to make sure it looks OK.
  • Note that the way github displays .md files online is different than how the markdown app converts them. Below are some tips:
    • Always use < pre> for code blocks (not a leading space)

About

Convert Markdown files to HTML

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages