Current File : //usr/share/doc/python2-markdown-2.4.1/extensions/tables.txt

title:      Tables Extension
prev_title: Footnotes Extension
prev_url:   footnotes.html
next_title: Smart Strong Extension
next_url:   smart_strong.html

Tables
======

Summary
-------

The Tables extension adds the ability to create tables in Markdown documents.

This extension is included in the standard Markdown library.

Syntax
------

Tables are defined using the syntax established in [PHP Markdown Extra][php].

[php]: http://www.michelf.com/projects/php-markdown/extra/#table

Thus, the following text (taken from the above referenced PHP documentation):

    First Header  | Second Header
    ------------- | -------------
    Content Cell  | Content Cell
    Content Cell  | Content Cell

will be rendered as:

    <table>
      <thead>
        <tr>
          <th>First Header</th>
          <th>Second Header</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td>Content Cell</td>
          <td>Content Cell</td>
        </tr>
        <tr>
          <td>Content Cell</td>
          <td>Content Cell</td>
        </tr>
      </tbody>
    </table>

Usage
-----

See [Extensions](index.html) for general extension usage, specify `tables`
as the name of the extension.

This extension does not accept any special configuration options.