Markdown syntax

From GarageSale Help
Jump to: navigation, search

In GarageSale you can use so-called Markdown syntax to easily format your item description.
Markdown is a lightweight markup language allowing people to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid HTML. Some of the advantages are that you can format your text in various ways without having any HTML knowledge.

So, if you're not familiar with HTML or if the formatting toolbar in GarageSale's Preview mode does not work for you, you should give the markdown syntax a try. To do so select Convert Markdown in description to HTML from the very right drop down menu in Editor mode.

To view the result you have to switch to GarageSale's Preview mode.

Markdown-ConvertMenu.png

Syntax examples

Each of the example markup syntax in the highlighted boxes below can be copied and pasted directly into the text field in GarageSale's Editor mode.

Headings

Headings are produced by placing a number of hashes before the header text corresponding to the level of heading desired (HTML offers six levels of headings), like so:

 # This is H1
## This is H2
### This is H3
#### This is H4
##### This is H5
###### This is H6

This will produce:

Markdown-Headings.png

Emphasized text

Wrap text with one asterisk (*), like so:

*This is emphasized text*

This is an *emphasized* word

This will produce:

Markdown-Emphasized.png

Strong text

Wrap text with two asterisk, like so:

**This is strong text**

This is a **strong** word

This will produce:

Markdown-Strong.png

Paragraphs

A paragraph is one or more consecutive lines of text separated by one or more blank lines. Normal paragraphs should not be indented with spaces or tabs:

text text text text text text text text text

text text text text text text text text text

Line Breaks

When you do want to insert a line break using Markdown, you end a line with two or more spaces, then type return. If you highlight the first line in the box below you'll notice the two spaces:

text text text  
text text text

Enumerated Lists

Enumerated (ordered) lists are created using "1." + Space:

1. Ordered list item
2. Ordered list item
3. Ordered list item
4. Ordered list item

This will produce:

Markdown-OrderedList.png

Bulleted Lists

Bulleted (unordered) list are created using "*" + Space:

* Unordered list item
* Unordered list item
* Unordered list item
    * A subitem, indented with 4 spaces
* Unordered list item

This will produce:

Markdown-UnorderedList.png

Horizontal rules

Horizontal rules are created by placing three or more asterisks or dashes: Each of the following lines will produce one horizontal rule:

***
---
--------------------

Tables

Use dashes and tailing pipes to easily create tables, like this:

1. Header | 2. Header | 3. Header
-------------- | -------------- | -------------
Cell Text | Cell Text | Cell Text
Cell Text | Cell Text | Cell Text

This will produce:

Markdown-table.png

Specify alignment for each column by adding colons (:) to separator lines:

1. Header | 2. Header | 3. Header
:------------- | :------------: | ------------:
Left | Center | Right
Left | Center | Right

This will produce:

Markdown-tableAlignment.png


Using HTML

If needed you can insert HTML code, like this table, too.

<table style="border-spacing: 5px; border: solid 1px #bbb;">
<tr><td>condition:</td><td>new</td></tr>
<tr><td>color:</td><td>blue</td></tr>
<tr><td>size:</td><td>medium</td></tr>
</table>

This will produce:

Markdown-HTML.png

Helpful Links

If you want to learn more about the markdown syntax you'll find additional information on these websites: