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
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.
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 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
markable.in is a very nice online tool for editing Markdown syntax
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.