Lai Yu-Hsuan Lai Yu-Hsuan - 2 months ago 5x
Markdown Question

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

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

I guess there is an editor or syntax explanation somewhere.

Where can I find an introduction to


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

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

Since it is a text file, 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 and They provide live preview. You can also export your files to Google Drive or Dropbox.