Every time I sit down to write something with Markdown, I end up screwing up half of the formatting syntax. I inevitably reverse the image link/description tags, or confuse italic with bold. I have to skim through a 25 page Markdown formatting document, trying to find the right syntax. By the time I find the right tags, I've forgotten what I wanted to write.
Bug is written with visual mnemonics, so it's a bit easier to remember the syntax. And the syntax follows consistent rules. In fact, it's so simple that all of the characters you use to format build a little flying bug:
{`}
~-#*>
[']
Bug is a BYOB markup language: Build-Your-Own-Bugup. You can change the markup symbols to anything you like, and the syntax parser will automagically convert them into html tags.
Formatting Quick-Reference
Bold
**Bold text** uses two sets of asterisks.Italic
~~Italic text~~ uses two sets of tildes.
Center
--Centered text-- uses two sets of hyphens.Blockquote
>>>Blockquoted text>>> uses two sets of greater-than signs.
Hyperlink
Hyperlinks are made by wrapping [the.website.domain]{and the link's description} using square brackets for the url, and curlybraces for the description.
You can also make a "local" hyperlink (one that refers to pages on your kiki site) with a simple [page_name].
Images
An image with an alt-description is inserted with: #[tomotama.com/images/bug.png]{an illustration of a bug} using a pound sign and square brackets for the url, and curlybraces for the description.Preformatted
'''Preformatted text
can
appear on multiple
lines and uses
two sets of three
single-quotes.
'''
Code
```
Lines
of code
use two sets of
three accent graves (backticks).
```