Here is some basic syntax documentation for markdown, which was originally written for ikiwiki. It's not intended to be complete, but is enough to get started. Feel free to include this in the package. Maybe in the man page?
Markdown uses a form very close to how you might write text for an email message. It works like this: Leave blank lines between paragraphs. You can **emphasise** or ****strongly emphasise**** text by placing it in single or double asterisks. To create a list, start each line with an asterisk: * this is my list * another item To make a numbered list, start each line with a number (any number will do) followed by a period: 1. first line 2. second line 2. third line To create a header, start a line with one or more `#` characters followed by a space and the header text. The number of `#` characters controls the size of the header: # h1 ## h2 ### h3 #### h4 ##### h5 ###### h6 To create a horizontal rule, just write three or more dashes or stars on their own line: ---- To quote someone, prefix the quote with ">": > To be or not to be, > that is the question. To write a code block, indent each line with a tab or 4 spaces: 10 PRINT "Hello, world!" 20 GOTO 10 To link to another web page, or to an email address, you can just put the url in angle brackets: <http://example.com/>, or you can use the form [example link text](http://example.com) For complete documentation of markdown syntax, see <http://daringfireball.net/projects/markdown/syntax>. -- see shy jo
signature.asc
Description: Digital signature