You are viewing an older revision! See the latest version
Wiki Syntax
Wiki Syntax¶
The mbed wiki syntax is a plain text markup based on the standardised Creole wiki markup, with some enhancements we find useful.
Text and Paragraphs¶
This is a first sentence. And a second. And a third.
This is a first sentence. And a second.
And a third.
forced\\linebreak
forced
linebreak
Headings¶
= Heading 1 = == Heading 2 == === Heading 3 ===
Heading 1¶
Heading 2¶
Heading 3¶
Styles¶
**bold text**, //italic//, __underline__, --stroke--, ^^superscript^^, ,,subscript,,, ##monospace##
bold, italic, underline, stroke, superscript, subscript, monospace
**//bold italic//**, **##bold monospaced##**
bold italic, bold monospaced
Lists¶
* List Item 1 * List Item 2 ** List Item 2.1 * List Item 3
- List Item 1
- List Item 2
- List Item 2.1
- List Item 3
# Ordered Item 1 ## Ordered Item 1.1 ## Ordered Item 1.2 ### Ordered Item 1.2.1 # Ordered Item 2
- Ordered Item 1
- Ordered Item 1.1
- Ordered Item 1.2
- Ordered Item 1.2.1
- Ordered Item 2
Links¶
* [[Wiki Syntax]] * [[/handbook/SPI]] * [[http://mbed.org]] * [[/handbook/SPI|SPI Handbook Page]]
Images¶
{{/media/uploads/simon/mbed.gif}} {{/media/uploads/simon/mbed.gif|mbed Logo}}
Image Links¶
[[http://mbed.org|{{/media/uploads/simon/mbed.gif}}]] [[http://mbed.org|{{/media/uploads/simon/mbed.gif|mbed Website}}]]
Videos¶
{{http://www.youtube.com/watch?v=Y6kECR7T4LY}}
Tables¶
|=Column 1 |=Column 2 |=Column 3 | |Some text | in a | table |
Column 1 | Column 2 | Column 3 |
---|---|---|
Some text | in a | table |
Code¶
<<code>> int max(int x, int y) { return (x > y) ? x : y; } <</code>>
int max(int x, int y) { return (x > y) ? x : y; }
<<code main.cpp>> #include "mbed.h" int main() { printf("Hello World!\n"); } <</code>>
main.cpp
#include "mbed.h" int main() { printf("Hello World!\n"); }
Quotes¶
<<quote>> This is something very interesting... <</quote>>
Quote:
This is something very interesting...
<<quote simon>> This is something simon said... <</quote>>
wrote:
This is something simon said...
Flashboxes¶
Flashbox types: info
, help
, error
, warning
, success
, note
<<info>> This is something that might be useful... <</info>>
Information
This is something that might be useful...
<<warning title="Troubleshooting!">> Some help with troubleshooting <</warning>>
Troubleshooting!
Some help with troubleshooting
Escaping Markup¶
{{{ plain text <<code>> not **formatted** by the wiki engine }}}
plain text <<code>> not **formatted** by the wiki engine
~# hello
# hello
<<comment>> something not rendered in the output <</comment>>
(nothing!)