intro.tmd

$ TERMINAL MARKDOWN                                                   $
*Terminal markdown* is an easy way to format text on a terminal window.
It supports the following styles:

      #BOLD#
      ~DIM~
      *ITALIC*
      _UNDERLINED_
      @BLINKING@
      $INVERTED$
      `HIDDEN`      ~(hidden)~
      %STRIKETHROUGH%
      ^rFO^gRE^yGR^bOU^mND^cS^
      ^RFO^GRE^YGR^BOU^MND^CS^ ~(bright)~
      |rBA|gCK|yGR|bOU|mND|cS|
      |RBA|GCK|YGR|BOU|MND|CS| ~(bright)~

|r  |R #Note:# some of the above styles are not supported universally. |

#_How to Use_#

To style text, wrap it in a special character. The special characters
and their associated styles are

      \#  : #BOLD#
      \~  : ~DIM~
      \*  : *ITALIC*
      \_  : _UNDERLINED_
      \@  : @BLINKING@
      \$  : $INVERTED$
      \`  : `HIDDEN` ~(hidden)~
      \%  : %STRIKETHROUGH%

#Colors:#

      \^X : FOREGROUND, where X determines the color:
            X = l : ^l BLACK      ^ L : ^L WHITE          ^ ~('l' for 'lightness')~
            X = r : ^r RED        ^ R : ^R BRIGHT RED     ^
            X = g : ^g GREEN      ^ G : ^G BRIGHT GREEN   ^
            X = y : ^y YELLOW     ^ Y : ^Y BRIGHT YELLOW  ^
            X = b : ^b BLUE       ^ B : ^B BRIGHT BLUE    ^
            X = c : ^c CYAN       ^ C : ^C BRIGHT CYAN    ^
            X = m : ^m MAGENTA    ^ M : ^M BRIGHT MAGENTA ^
      \|X : BACKGROUND, where X determines the color:
            X = l : |l BLACK      | L : |L WHITE          |
            X = r : |r RED        | R : |R BRIGHT RED     |
            X = g : |g GREEN      | G : |G BRIGHT GREEN   |
            X = y : |y YELLOW     | Y : |Y BRIGHT YELLOW  |
            X = b : |b BLUE       | B : |B BRIGHT BLUE    |
            X = c : |c CYAN       | C : |C BRIGHT CYAN    |
            X = m : |m MAGENTA    | M : |M BRIGHT MAGENTA |

|b  |B #Note:# The absense of X in the above cases (that is, if |
|b  |B something other than the above list of letters appears |
|b  |B after the \^ or \|) restores the color to default.       |

The backslash can be used to escape these special characters.

#_Examples_#

      _original_                         _rendered_

      \#Hello\# \~world\~!                 #Hello# ~world~!
      \*\_\^rHello\^ \%world\%\_!\*            *_^rHello^ %world%_!*
      \|CHello \\\| \^bworld\^\|!            |CHello \| ^bworld^|!
      \^CHello \\\^ \|bworld\|\^!            ^CHello \^ |bworld|^!
      \@\|g\^r Merry\^ \|r\^g Christmas \^\|\@  @|g^r Merry^ |r^g Christmas ^|@