Using Markdown to Make your ReadMe Documentation

by Sai Hemchandra

If you have a document you would like to post on the web, you first have to turn it into an HTML document.

The easiest way, is to use your favorite text editor and use the “save as” option. When in the “save as” screen, click on the “save as type” box. A list will then appear under it. From that list, pick “HTML document (*.html,*.htm,*.htx)” This way your file is saved as an HTML document.

However, there may be occasions where you want to convert text into HTML for web publishing. It could be a tedious process if you are attempting this from first principles.

In a world where there is no clear markdown standard, a developer will want to be sure to choose a tool that is lightweight, easy to format and a readable formatting syntax. One elegant way is to use a conversion tool like MARKDOWN(.md).

MARKDOWN is a light-weight mark-up language allows you to write using an easy-to-read, easy-to-write plain text format and then convert the text to structurally valid XHTML (or HTML).

The idea for MARKDOWN is to make it easy to read, write and edit prose. HTML is a publishing format; MARKDOWN is a writing format. Hence, MARKDOWN’s formatting syntax only addresses issues that can be conveyed in plain text.

The formatting syntax is as readable as possible, publishable as-is-as plain text, without marked up tags or formatting instructions.

Leave a Reply

Your email address will not be published. Required fields are marked *

Tools & Practices

Tools and Technologies we use at Applied

Contact us now

Popular Posts