What file uses .md extension and how should I edit them?

Question

On GitHub, several projects have README.md files. It seems like a simple format file to express text and pictures.

I guess there is an editor or syntax

Answer 1

Stack Edit is an online markdown editor with the ability to save to Google Drive and DropBox.

Answer 2

Markdown is a plain-text file format. The extensions .md and .markdown are just text files written in Markdown syntax. If you have a Readme.md in your repo, GitHub will show the contents on the home page of your repo. Read the documentation:

• Standard Markdown
• GitHub Flavored Markdown

You can edit the Readme.md file in GitHub itself. Click on Readme.md, you will find an edit button. You can preview your changes and even commit them from there.

Since it is a text file, Notepad or Notepad++ (Windows), TextEdit (Mac) or any other text editor can be used to edit and modify it. Specialized editors exist that automatically parse the markdown as you type it and generate a preview, while others apply various syntax coloring and decorations to the displayed text. In both cases though, the saved file is still a readable text file.

If you want to create an md file with preview and if you prefer not to install any special editors, you can use online editors like dillinger.io and stackedit.io. They provide live preview. You can also export your files to Google Drive or Dropbox.

Answer 3

Extension '.md' refers to Markdown files.

If you don't want to install an app to read them in that format, you can simply use TextEdit or Xcode itself to open it on Mac.

On any other OS, you should be able to open it using any text editor, though as expected, you will not see it in Markdown format.

Answer 4

The .md stands for Markdown Text. Basically, its just another type of text file, like .txt

I use Notepad++ for reading and editing these

Answer 5

There is an ongoing effort to standardize Markdown and as of now, this is probably the best place to learn about markdown:

http://standardmarkdown.com/

Answer 6

BBEdit will also display MD on the mac.

and here is a quicklook plugin to display them when you preview them.