Markdown

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images. etc... with specific symbols like ```#``` or ```*``` Markdown benefits: - Human readable and easy to learn. - Produces valid XHTML output. - Platform independent. Use any text editor or Markdown application you like. - Markdown best choice for flat file CMS ##Headings Headings from ```h1``` through ```h6``` are constructed with a ```#``` for each level: ``` # h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading ``` Renders to: # h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading HTML: ```

h1 Heading

h2 Heading

h3 Heading

h4 Heading

h5 Heading
h6 Heading
``` ## Comments Comments should be HTML compatible ``` ``` Comment below should NOT be seen. ## Inline HTML If you need a certain HTML tags you can simply use HTML ``` Paragraph in Markdown.

Some text here

Paragraph in Markdown. ``` Renders to: Paragraph in Markdown.

Some text here

Paragraph in Markdown. HTML: ```

Paragraph in Markdown.

Some text here

Paragraph in Markdown.

``` ## Emphasis ``` *This text will be italic* _This will also be italic_ **This text will be bold** __This will also be bold__ _You **can** combine them_ ~~Strike through this text.~~ ``` Renders to: *This text will be italic* _This will also be italic_ **This text will be bold** __This will also be bold__ _You **can** combine them_ ~~Strike through this text.~~ HTML: ``` This text will be italic This will also be italic This text will be bold This will also be bold You can combine them Strike through this text. ``` ## Blockquotes ``` > Coffee. The finest organic suspension ever devised… I beat the Borg with it. - Captain Janeway ``` Renders to: > Coffee. The finest organic suspension ever devised… I beat the Borg with it. - Captain Janeway HTML: ```

Coffee. The finest organic suspension ever devised… I beat the Borg with it. - Captain Janeway

``` ## Lists ### Unordered ``` + Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in pretium nisl aliquet + Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at + Faucibus porta lacus fringilla vel + Aenean sit amet erat nunc + Eget porttitor lorem ``` Renders to: + Lorem ipsum dolor sit amet + Consectetur adipiscing elit + Integer molestie lorem at massa + Facilisis in pretium nisl aliquet + Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at + Faucibus porta lacus fringilla vel + Aenean sit amet erat nunc + Eget porttitor lorem HTML: ```
  • Lorem ipsum dolor sit amet
  • Consectetur adipiscing elit
  • Integer molestie lorem at massa
  • Facilisis in pretium nisl aliquet
  • Nulla volutpat aliquam velit
    • Phasellus iaculis neque
    • Purus sodales ultricies
    • Vestibulum laoreet porttitor sem
    • Ac tristique libero volutpat at
  • Faucibus porta lacus fringilla vel
  • Aenean sit amet erat nunc
  • Eget porttitor lorem
``` ###Ordered ``` 1. Lorem ipsum dolor sit amet 2. Consectetur adipiscing elit 3. Integer molestie lorem at massa 4. Facilisis in pretium nisl aliquet 5. Nulla volutpat aliquam velit 6. Faucibus porta lacus fringilla vel 7. Aenean sit amet erat nunc 8. Eget porttitor lorem ``` Renders to: 1. Lorem ipsum dolor sit amet 2. Consectetur adipiscing elit 3. Integer molestie lorem at massa 4. Facilisis in pretium nisl aliquet 5. Nulla volutpat aliquam velit 6. Faucibus porta lacus fringilla vel 7. Aenean sit amet erat nunc 8. Eget porttitor lorem HTML: ```
  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. Integer molestie lorem at massa
  4. Facilisis in pretium nisl aliquet
  5. Nulla volutpat aliquam velit
  6. Faucibus porta lacus fringilla vel
  7. Aenean sit amet erat nunc
  8. Eget porttitor lorem
``` ## Tables ``` | Option | Description | | ------ | ----------- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | ``` Renders to: | Option | Description | | ------ | ----------- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. |
HTML: ```
Option Description
data path to data files to supply the data that will be passed into templates.
engine engine to be used for processing templates. Handlebars is the default.
ext extension to be used for dest files.
``` ## Links ``` [Flextype site](http://Flextype.org) ``` Renders to: [Flextype site](http://Flextype.org) HTML: ``` Flextype site ``` ## Images ``` ![filmtocat](https://octodex.github.com/images/filmtocat.png) ``` Renders to: ![filmtocat](https://octodex.github.com/images/filmtocat.png) HTML: ``` filmtocat ``` ``` ![filmtocat](https://octodex.github.com/images/filmtocat.png){.img-responsive} ``` Renders to: ![filmtocat](https://octodex.github.com/images/filmtocat.png){.img-responsive} HTML: ``` filmtocat ```