

The paragraphs below highlight benefits of Markdown over other ways to structure text pieces. There are also a bit more exotic markup languages such as Textile and MediaWiki. Some writers are used to WISYWIG text editors, some prefer HTML or even BBCode/phpBB. That may not be convincing, sure, but it definitely indicates that some people agree with the Markdown principles and that the syntax is good for numerous tasks. It is used as a default markup language on GitHub, StackOverflow, Reddit and a number of CMS. Since its first release in 2004, Markdown has been growing more and more popular. It creates highly readable content without having to get into the HTML or source code. It gives editors the power to design how their writing and elements look on the page. How is Markdown different from Rich Text formatting? Rich text is a formatting type that gives authors a wide range of formatting options. Markdown helps format text – add headings, lists, bold, italic, inline images and so on – by applying relatively simple and non-intrusive markup. A brief introduction to Markdown So, what is Markdown?Īccording to the project website, " Markdown is a plain text formatting syntax". Here at Contentful we respect the authors and the thoughts and ideas they put into words, so the writing experience is as important to us as a flexible API and stable infrastructure. The unhappy writers will revolt, and the CMS will be replaced. If a CMS doesn't address the needs of the writers, it's doomed to be hated. Sympathetic sidenote about the role of a writer Open any entry corresponding to that content type, and the Markdown editor will be waiting there. Open a content type that contains a Long text fieldĭon't forget to save the new content type settings Open the Content types section (note that it's visible only if you have the necessary access level – that is, Developer or Admin) In case you forgot or somehow missed the Contentful built-in Markdown editor, see how to enable it below. We followed the GitHub-flavored Markdown specification, so there should be few surprises on the way. See the docs for in-depth coverage of the editor features and Markdown syntax. There's also keyboard shortcuts, automatic inline links cleanup, and other things beyond the scope of this post. We've introduced better ways to embed non-textual content, such as images, videos and tweets, into Markdown-formatted texts. You can also see an HTML preview of the Markdown-formatted content: Media embedding Switch to full-screen to hide all the interface elements – except for the text area.

The highlighting helps seeing how the finished copy would look like and simplifies editing. It's hard to believe it wasn't there before. However, we encourage you to invest some time into understanding how Markdown improves authoring experience and what principles it's based upon. Scroll below for a brief illustrative overview of the update, and also for some obvious thoughts on why Markdown is something useful, not yet another buzzword.
