The goal of Markdown for Sitecore is to provides user with an elegant, expressive, lightning-fast alternative for content creation.
Markdown is a writing format (not a publishing format like HTML and XML). If you're new to Markdown this is the best place to start.
It turns this quickly-typed, easy to read content from this:
Significant Events In History
History is full of signification events. It's doubtful that Markdown for Sitecore will be historically significant but hopefully it's useful to the Sitecore community.
* The _first_ item in a lists
* One before the third item
* Finally the 3rd item
Obligatory link to (Sitecore)[http://www.sitecore.net] before we show tables.
Cools Things About Sitecore
Feature | True or False
marketer-friendly | true
developer-friendly | true
ContentSearch API | true
> Markdown for Sitecore is handy.
> - Anonymous
<h1 id="significant-events-in-history">Significant Events In History</h1>
<p>History is full of signification events. It’s doubtful that Markdown for Sitecore will be historically significant but hopefully it's useful to the Sitecore community.</p>
<li>The <em>first</em> item in a lists</li>
<li>One before the third item</li>
<li>Finally the 3rd item</li>
<p>Obligatory link to <a href="http://www.sitecore.net">Sitecore</a> before we show tables.</p>
<h2 id="cools-things-about-sitecore">Cools Things About Sitecore</h2>
<th align="left">True or False</th>
<td align="left">ContentSearch API</td>
<p>Markdown for Sitecore is handy. - Anonymous</p>
When the installation is complete select the Markdown field type in your template. Use the Source attribute of the field located in the items template to configure. This way, your attributes are applied using <sc:RenderField /> and when indexed/accessed via the ContentSearch API.
Configurable attributes are all have corresponding 1 (true) or 0 (false) values:
(*) = with extramode enabled
The most frequently used options are safemode & extramode. By mixing these Markdown for Sitecore can run in a variety of modes. Options are declared in a query string format:
// The settings used for this blog post!
// Markdown only please, safemode=1 is great to constrain content authoring
Use it in a page like any other field:
<sc:renderField FieldName="YourMarkdownField" runat="server" />
OOTB the Fishtank.Markdown.config adds a line to so Markdown fields are handled by the ContentSearch API as well.
<fieldReader fieldTypeName="markdown" fieldReaderType="Fishtank.CustomFields.Markdown.FieldReaders.MarkdownFieldReader, Fishtank.CustomFields.Markdown" />
Markdown for Sitecore is built on top of MarkdownDeep. For syntax on how to author Markdown content I'd recommend:
To get up and running quickly download and install package for your Sitecore version below. Select merge/merge if prompted during install.
Each Sitecore package contains:
To build your own version of Markdown for Sitecore and integrate into Visual Studio solution, you can find it's GitHub repo here as well as the Sitecore 7 and Sitecore 6 versions respectively.
Here is a high-level overview of the steps to integrate it into your solution:
When doing an advanced installation please check the following:
We'd love to know what you think. We created this to support the Sitecore community so we welcome your input. If you use this module please drop us a line in the comments.
Also find Markdown for Sitecore in the Sitecore Marketplace.