From f20e7b551689a365ce67be3394baf67e88cc77a7 Mon Sep 17 00:00:00 2001 From: "gottox@rootkit" Date: Tue, 22 Jan 2008 10:50:18 +0100 Subject: renamed smutest into testdoc. Added documentation. Changed copyright. --HG-- rename : smutest => testdoc --- LICENSE | 2 +- Makefile | 2 +- documentation | 190 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ smu.c | 2 +- smutest | 55 ----------------- testdoc | 55 +++++++++++++++++ 6 files changed, 248 insertions(+), 58 deletions(-) create mode 100644 documentation delete mode 100644 smutest create mode 100644 testdoc diff --git a/LICENSE b/LICENSE index 3e505dd..73bb1d5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT/X Consortium License -(c) 2007 Enno Boland +(c) 2007, 2008 Enno Boland Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/Makefile b/Makefile index d11180b..2e45388 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # smu - simple markup -# (c) 2007 Enno Boland +# (c) 2007, 2008 Enno Boland include config.mk diff --git a/documentation b/documentation new file mode 100644 index 0000000..ecf346d --- /dev/null +++ b/documentation @@ -0,0 +1,190 @@ +smu - a Simple Markup Language +============================== + +_smu_ is a very simple and minimal markup language. It is designed for using in +wiki-like environments. smu makes it very easy to write your documents on the +fly and convert them into HTML. + +smu is capable to parse very large documents. As long as you avoid an huge +amount of indents it scales just great. (This will be fixed in future releases +of smu) + +Syntax +====== + +smu was started as a rewrite of +[markdown](http://daringfireball.net/projects/markdown/) but became something +more lightweight and consistent. The biggest difference between markdown and smu +is that smu doesn't support _reference style links_ + +Inline pattern +-------------- + +There are several pattern you can use to highlight your text: + + * Emphasis + * Surround your text with `*` or `_` to get *emphasis* text: + This *is* cool. + This _is_ cool, too. + * Surround your text with `**` or `__` to get **strong** text: + This **is** cool. + This __is__ cool, too. + * inline Code + + You can produce inline code with surrounding `\`` or `\`\`` + Use `rm -rf /` if you're a N00b. + + Use ``rm -rf /`` if you're a N00b. + + `\`\`` makes it possible to use Backticks without backslashing them. + + +Titles +------ + +Creating titles in smu is very easy. There are two different syntax styles. The +first is underlining: + + Heading + ======= + + Topic + ----- + +This very intuitive and self explaining. The resulting sourcecode looks like +this: + +

Heading

+

Topic

+ +Use the following prefixes if you don't like underlining: + + # h1 + ## h2 + ### h3 + #### h4 + ##### h5 + ###### h6 + +Links +----- + +The simplest way to define a link is with simple `<>`. + + + +You can do the same for E-Mail addresses: + + + +If you want to define a label for the url, you have to use a different syntax + + [smu - simple mark up](http://s01.de/~gottox/index.cgi/proj_smu) + +The resulting HTML-Code + + smu - simple mark up

+ +Lists +----- + +Defining lists is very straightforward: + + * Item 1 + * Item 2 + * Item 3 + +Result: + +
    +
  • Item 1
    • +
  • Item 2
    • +
  • Item 3
    • +
+ +Defining ordered lists is also very easy: + + 1. Item 1 + 2. Item 2 + 3. Item 3 + +It is possible to use any leading number you want. So if you don't want to keep +your list synchron, you simple can use any number. In this case it's +recommended to use `0.`, but it isn't mandatory. + + 0. Item 1 + 0. Item 2 + 0. Item 3 + +Both examples will cause the same result. Even this is possible: + + 1000. Item 1 + 432. Item 2 + 0. Item 3 + +This will be the result in these example: + +
    +
  1. Item 1
    2. +
  2. Item 2
    3. +
  3. Item 3
    4. +
+ +Code & Blockquote +----------------- + +Use the `> ` as a line prefix for defining blockquotes. The blockquotes are +interpreted. This makes it possible to embed links, headings and even other +quotes into a quote: + + > Hello + > This is a quote with a [link](http://s01.de/~gottox) + +Result: +

+ Hello + This is a quote with a link

+
+ + +You can define block code with a leading Tab or with __3__ leading spaces + + this.is(code) + + this.is(code, too) + +Result: + 
this.is(code)
+ 
this.is(code, too)
+
+ +Please note that code you can't use any HTML or smu syntax pattern in a code +block. + +Other interesting stuff +----------------------- + + * to insert a horizontal rule simple add `- - -` into an empty line: + + Hello + - - - + Hello2 + + Result: +

+ Hello +

+ + Hello2

+ * You can escape the following pattern to avoid them from being interpreted: + `` \ ` * _ { } [ ] ( ) # + - . ! `` + + * To force a linebreak simple add two spaces to the end of the line: + + No linebreak + here. + But here is + one. + +embed HTML +---------- diff --git a/smu.c b/smu.c index a955d69..aa08bb6 100644 --- a/smu.c +++ b/smu.c @@ -1,5 +1,5 @@ /* smu - simple markup - * Copyright (C) <2007> Enno boland + * Copyright (C) <2007, 2008> Enno boland * * See LICENSE for further informations */ diff --git a/smutest b/smutest deleted file mode 100644 index c70f95d..0000000 --- a/smutest +++ /dev/null @@ -1,55 +0,0 @@ -smu test -======== - -simple tests ------------- - -first paragraph. -testing surround: _emph_ then **strong** and `code`. - -horizontal rule: - -- - - - - -blocks and entities -------------------- - -preformatted block: - --- - \ |\ /| | | - \ | | |__| - --- - -quoted text: -> When in doubt, -> use brute force. - -list: -* Make each program do one thing well. -* Expect the output of every program to become the input to another, -as yet unknown, program. -* Design and build software, even operating systems, to be tried early, -ideally within weeks. -* Use tools in preference to unskilled help to lighten a programming task. - -list in list: -* a - * b - 1. c - 2. d - * e -* f - -entity: &, <, > - -code: - int powerof2(unsigned int n) { - return !((n - 1) & n) && n > 0; - } - -links ------ - -[suckless](http://suckless.org) - diff --git a/testdoc b/testdoc new file mode 100644 index 0000000..c70f95d --- /dev/null +++ b/testdoc @@ -0,0 +1,55 @@ +smu test +======== + +simple tests +------------ + +first paragraph. +testing surround: _emph_ then **strong** and `code`. + +horizontal rule: + +- - - + + +blocks and entities +------------------- + +preformatted block: + --- + \ |\ /| | | + \ | | |__| + --- + +quoted text: +> When in doubt, +> use brute force. + +list: +* Make each program do one thing well. +* Expect the output of every program to become the input to another, +as yet unknown, program. +* Design and build software, even operating systems, to be tried early, +ideally within weeks. +* Use tools in preference to unskilled help to lighten a programming task. + +list in list: +* a + * b + 1. c + 2. d + * e +* f + +entity: &, <, > + +code: + int powerof2(unsigned int n) { + return !((n - 1) & n) && n > 0; + } + +links +----- + +[suckless](http://suckless.org) + -- cgit v1.2.3