Blame

67a56b OtterWiki Demo 2024-12-02 18:04:42 1
# Examples
2
3
In markdown paragraphs are seperated by a blank line.
4
5
Without an empty
6
line, a block of
7
words will be rendered
8
as paragraph.
9
10
Individuals words or sentences can be emphasized as `monospace`, **bold**, _italic_
11
or **_bold and italic_**. Or go wild and ==mark== or ~~strike out~~ words.
12
13
An Otter Wiki stores all pages in UTF-8 in a git repository. With UTF-8 you get emojis
14
like 🥳 and 🎆, that all modern browsers can display.
15
16
Some example for links in the middle of a paragraph.
17
[A link to the otterwiki github project](https://github.com/redimp/otterwiki),
18
followed by an auto linked url to http://example.com, followed by a mail address
19
<mailto:mail@example.com>. Commonly used are links inside the wiki, e.g. one pointing [[Home]].
20
21
## Tables
22
23
A table with some formatting and an emoji.
24
25
| Alpha | Bravo | Charlie |
26
|:-------- |:-----------------:| --------:|
27
| `D`elta | Echo | Foxtrott |
28
| Golf | **Hotel** | India |
29
| Juliett | Kilo | _Lima_ |
30
| ~~Mike~~ | November | Oscar |
31
| Papa | Quebec | Romeo |
32
| Sierra | Tango | Uniform |
33
| Victor | [Whisky](#tables) | X-Ray |
34
| Yankee | Zulu | 🦦 |
35
36
## Code blocks
37
38
Markdown is often used for documentation, so it's not a
39
surprise that it should be excellent in displaying code and configurations.
40
For example a minimal `docker-compose.yaml` for running An Otter Wiki:
41
42
```yaml
43
version: '3'
44
services:
45
otterwiki:
46
image: redimp/otterwiki:2.0
47
ports:
48
- 8080:80
49
```
50
51
This and many other examples for syntax highlighting can be found in the
52
[Syntax Highlighting Examples](https://otterwiki.com/Examples/Syntax%20Highlighting).
53
54
## List examples
55
56
Itemized lists look like
57
58
* this one
59
* with three
60
* items.
61
62
A numbered list
63
64
1. first item
65
2. second item
66
3. third item
67
68
And a task list
69
70
- [ ] a unchecked item
71
- [x] and **bold** checked item
72
73
*The task list can only be mofied by editing it, not by clicking the checkboxes while viewing it.*
74
75
## Math or LaTeX
76
77
If you want to share math formulas in your wiki, [MathJax](https://www.mathjax.org/) comes
78
to the rescue. For example:
79
80
When `$a \ne 0$`, there are two solutions to `$ax^2 + bx + c = 0$` and they are
81
```math
82
x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
83
```
84
85
Since you read until here, you may want to check an example with [All Syntax Features](https://otterwiki.com/Examples/All%20Syntax%20Features)