[in new window] [back] [close]
[introduction] [FAQ] [search] [what's new] [index]

About Markdown

When you upload a Markdown file (with a .md suffix), Ensembling displays the corresponding formatted pages.
Markdown is a simple syntax for use in plain text files that applies basic formatting to the content such as headings, paragraphs, bold and italic, bulleted lists, links etc.. The syntax is quite readable on its own. Here's the basics and the full specification

Including images

The Markdown syntax for an image is:
  ![alt-text](url-of-image)
While you can reference images on the internet, it is likely you will want to include your own images which are part of the document you are preparing.
To do this, upload an image to Ensembling, and reference it in Markdown using the URL of the Ensembling document or version containing the image, for example https://www.ensembling.com/12345
This only works inside Ensembling. If you use an external Markdown interpreter (for example in the Mac app Bear, or at dillinger.io, the interpreter wont be logged in to Ensembling so won't be able to access the image (and, in any case, the URL is referencing a document or version, not an actual image, which Ensembling knows how to interpret).
You can also use an abbreviated URL such as ensembling:12345, which recognisies this is special.

Getting your document out

In principle, circulating a Markdown file is similar to circulating a Microsoft Word document. However, while most recipients would have Word and therefore be able to open it, many people will not know what to do with a Markdown file. (They probably do have apps which will read it, they just don;t know that)
One possibility is to export your file as PDF for use elsewhere. This correctly embeds any Ensembling images referenced. To do this,use on the menu.