Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
pekkaklarck committed Sep 29, 2014
1 parent de5b318 commit 1123b3d
Showing 1 changed file with 27 additions and 19 deletions.
46 changes: 27 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,38 @@ resttest

Testing reStructuredText support on GitHub \*.rst files

Roles
-----

Default roles:

- :code:`code role`
- :literal:`literal`
- :emphasis:`emphasis`
- :strong:`strong`
- `single backticks (by default alias for title-reference)`
- ``literal using duoble backticks``
- *emphasis using asterisks*
- **strong using double asterisks**

Customization:
Default roles
-------------

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

Customized roles
----------------

.. default-role:: code
.. role:: custom
.. role:: inherit(emphasis)

- :custom:`custom role`
- :inherit:`inheriting role`
- `single backtics (after changing default role to code)`
================================== ============= =============== =========
Normal text One backslash Two backslashes Comment
================================== ============= =============== =========
:custom:`custom role` c:\temp\dir c:\\temp\\dir
:inherit:`inheriting role` c:\temp\dir c:\\temp\\dir
`single backtics` c:\temp\dir c:\\temp\\dir Default role changd to code.
================================== ============= =============== =========

Errors:
Non-existing roles
------------------

- :nonex:`non-existing role`

0 comments on commit 1123b3d

Please sign in to comment.