GitHub reStructuredText Test

This document tests various reStructeredText features when rendered on GitHub. The motivation is to test what kind of styles GitHub uses and how different features actually work here.

• Roles
  • Default roles
  • Customized roles
  • Non-existing roles
• Lists
• Links
• Escaping
• Tables
  • List-table

Roles

Testing reStructuredText support on GitHub *.rst files

Default roles

Normal text	One backslash	Two backslashes	Comment
code role	c:\temp\dir	c:\\temp\\dir
literal	c:tempdir	c:\temp\dir
emphasis	c:tempdir	c:\temp\dir
strong	c:tempdir	c:\temp\dir
single backticks	c:tempdir	c:\temp\dir	By default alias for title-reference
literal using duoble backticks	c:\temp\dir	c:\\temp\\dir	Standard alias.
emphasis using asterisks	c:tempdir	c:\temp\dir	Standard alias.
strong using double asterisks	c:tempdir	c:\temp\dir	Standard alias.

Customized roles

Normal text	One backslash	Two backslashes	Comment
custom role	c:tempdir	c:\temp\dir
inheriting role	c:tempdir	c:\temp\dir
single backtics	c:\temp\dir	c:\\temp\\dir	Default role changed to code.

Non-existing roles

• :nonex:`non-existing role`

Lists

Unordered without indentation:

• First item
• Second
• Third

Unordered with indentation:

• First item
• Second
• Third

Ordered without indentation:

1. First item
2. Second
3. Third

Ordered with indentation:

1. First item
2. Second
3. Third

Links

• Explicit target
• Target with spaces
• Links is implicit target
• Anonymous link
• Embedded URI
• Embedded alias

Escaping

• http://example.com
• \http://example.com

Tables

List-table

With title and widths:

A title is pretty useless

ID	Type	Priority	Summary
#42	Bug	Critical	Just testing here, nothing more
#1	Enhancement	Low	Testing, testing, 1 2 3. With very long summary. With very long summary. With very long summary.

Without title and widths:

ID	Type	Priority	Summary
#42	Bug	Critical	Just testing here, nothing more
#1	Enhancement	Low	Testing, testing, 1 2 3. With very long summary. With very long summary. With very long summary.