Markdown Guide

Tips for composing content using Markdown

Markdown is an easy-to-read, lightweight formatting language that enables you to add formatting to your content using plain text. Pennsieve supports basic markdown syntax with some Github flavored syntax.

Common formatting is made available on the text formatting toolbar that is displayed in Markdown-friendly text fields.

Note: Pennsieve does not currently supported uploading or linking to images using Markdown.

Basics

Formatting Text

Bolding, italics and underlines can be added to your text by using the following syntax:

If you really look _closely_, most overnight successes took a **long time**.

Will be displayed as:

If you really look closely, most overnight successes took a long time.

Links

You can create a link by wrapping link text in brackets [ ], and then wrapping the URL in parentheses ( ).

This is a link to the [Pennsieve homepage](https://app.pennsieve.io)

This is a link to the Pennsieve homepage

You can include a link title by including some text in quotes right after your URL.

This is a link to the Pennsieve homepage ("The Pennsieve homepage.")

Headings

You can add headings to your content by prefacing a word or phrase with a hash symbol followed by a space. The number of hash symbols assigns the appropriate header formatting.

Heading 1

Heading 2

Heading 3

Heading 4

Pennsieve supports up to five heading levels.

Lists

You can make an unordered (bulleted) list by preceding a word or sentence with a hyphen or an asterisk, followed by a space.

* Santiago Ramon y Cajal
* Hippocrates
* Marian Diamond
  • Santiago Ramon y Cajal
  • Hippocrates
  • Marian Diamond

Ordered lists can by created by prefacing a work or sentence with a number, followed by a period and a space.

1. Santiago Ramon y Cajal
2. Hippocrates
3. Marian Diamond
  1. Santiago Ramon y Cajal
  2. Hippocrates
  3. Marian Diamond

Advanced Formatting

There are many other formatting options that are supported in Markdown. Please refer to Jon Gruber's Markdown Syntax for more.