Using Markdown

In Pulse, you can use Markdown to write content in pages, blocks or the blog. Anything you type in Markdown format will automatically be converted to HTML on the fly when the content is viewed on the frontend. If you want to use Markdown in blocks and blog pages you should first disable the WYSIWYG editor in config.php.

 $wysiwyg = false;

What is it and why should I use it?

From the creator,  John Gruber:

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

So basically, you get the power of a WYSIWYG without the clunky toolbar and messy code. You just need to learn a few syntax basics and you're ready to start using Markdown. It's mostly just plain text with a few special formatting styles. For example, to create a header and some body text, you would just write:

# My Section Title
This is some paragraph content.

This would be automatically converted to:

<h1>My Section Title</h1>
<p>This is some paragraph content.</p>

Let's run through some more examples of Markdown fun.

Examples of Markdown in Pulse

Headers

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

When typing in normal paragraph text, Pulse automatically creates line breaks and paragraphs.

My first line
My second line

Some more info

Text Styles

**Bold Text**
*Italic Text*
**Bold and _italic_**.
Strikethrough uses two tildes. ~~strike out.~~
[A Link](https://www.google.com)

Images

![alt text](http://linkto/img.jpg)

Line breaks

___
***
---

Lists

1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
⋅⋅1. Ordered sub-list
4. And another item.
* Unordered list can use asterisks
- Or minuses
+ Or pluses

Blockquotes

If you can keep your head when all around you have lost theirs, then you probably haven't understood the seriousness of the situation.

Video

Just paste in embed video code from YouTube and Vimeo and it auto embeds.

Tip of the iceberg

This is just a quick summary of the power and flexibility of Markdown in Pulse. I'm using  IA Writer on the Macright now to update this entry. Wow. You can also use the gorgeous built-in Markdown editor in Pulse, or any text editor. After all, Markdown is just plain text.

For even more detail and Markdown cheatsheet work, see  Gruber's original article on the subject.

Still need help? Contact Us Contact Us