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

On GitHub, several projects have README.md fil开发者_JAVA百科es. 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 .md files?

---

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.

---

If you are looking for an editor, I suggest you use http://dillinger.io/. It is a simple browser-based text editor that can render Markdown on the fly.

However, if you prefer an app, and you are using OS X, you could try Mou. It is quite good and full of examples.

---

Github's Atom text editor has a live-preview mode for markdown files.

The keyboard shortcut is CTRL+SHIFT+M.

It can be activated from the editor using the CTRL+SHIFT+M key-binding and is currently enabled for .markdown, .md, .mkd, .mkdown, and .ron files.

---

Microsoft's Visual Studio Code text editor has built in support for .md files written in markdown syntax.

The syntax is automatically color-coded inside of the .md file, and a preview window of the rendered markdown can be viewed by pressing Shift+Ctrl+V (Windows) or Shift+Cmd+V (Mac).

To see them side-by-side, drag the preview tab to the right side of the editor, or use Ctrl+K V (Windows) or Cmd+K V (Mac) instead.

VS Code uses the marked library for parsing, and has Github Flavored Markdown support enabled by default, but it will not display the Github Emoji inline like Github's Atom text editor does.

Also, VS Code supports has several markdown plugins available for extended functionality.

---

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.

---

Yup, just GitHub flavored Markdown. Including a README file in your repository will help others quickly determine what it's about and how to install it. Very helpful to include in your repos.

---

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

---

Markdown is just a text file which optionally has .md, or .markdown extensions. It can be converted to HTML. To know syntax of Markdown, Check out

GitHub Flavored Markdown.

You can use any text editor for markdown. If you are sublime text user, you can check out Markdown Preview plugin which will display the rendered markdown content in browser and updates whenever you change the markdown file.

Some of the online markdown editor

• Markable
• dillinger
• markdownviewer

---

BBEdit will also display MD on the mac.

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

---

I suggest StackEdit. It is simple WISIWIG editor. You can use both editor and markdown syntax. There is a quick markdown help syntax there. Undo/redo, comments, GoogleDrive, Dropbox interconnection.

---

markable.in is a very nice online tool for editing Markdown syntax

---

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/

---

If you are creating .md files for your .NET solutions I recommend the Visual Studio 2015 extension Markdown Editor as it has a preview panel so you can see your changes in real time.

EDIT: This also should now work with Visual Studio 2017.

---

A .md file stands for a Markdown file extension. A popular app for editing these files is Typora

---

The easiest thing to do, if you do not have a reader, is to open the MD file with a text editor and then write the MD file out as an HTML file and then double click to view it with browser.

---

If you're willing to chip in some money, Writage is pretty good. It's a Microsoft Word add-on that enables Word to save in markdown format and read markdown files (.md or .markdown).

It doesn't work with all of Word's features, but it does enough to do most of what I need it to. It has its own tab in the ribbon so you can edit with the features it does support.

It's great because you can see the text the way it would be displayed while also being able to edit it in place.

https://www.writage.com/

The Writage ribbon tab:
NOTE: After installing, you have to restart Word in order for it to show up

A snippet of the intro page it gives you after installing:

---

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

I use Notepad++ for reading and editing these

---

**Basic writing and formatting syntax to .md files **

You can see the official documentation on Github