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 explanation somewhere.
Where can I find an introduction to .md files?
This question is related to
markdown
file-extension
The answer is
The .md stands for Markdown Text. Basically, its just another type of text file, like .txt
I use Notepad++ for reading and editing these
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.
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.
There is an ongoing effort to standardize Markdown and as of now, this is probably the best place to learn about markdown:
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
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
BBEdit will also display MD on the mac.
and here is a quicklook plugin to display them when you preview them.
Stack Edit is an online markdown editor with the ability to save to Google Drive and DropBox.
markable.in is a very nice online tool for editing Markdown syntax
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.
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.
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.
A .md file stands for a Markdown file extension. A popular app for editing these files is Typora
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.ronfiles.
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.
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.
Source: Stackoverflow.com