Olog Markup Quick Reference

Markup support in Olog is based on the Commonmark specification. Olog supports additional markup features: image size and tables.

In contrast to other markup implementations Olog does not support HTML in the source. HTML tags entered by user will be rendered as plain text.

The below list is a quick reference for the supported markup features. However, there are a few things to keep in mind when editing a log entry text:

  1. To begin a new line you need two blank characters at the end of the preceding line. Or an empty blank line, which will be rendered as a blank line.
  2. Markup for images can be created in either of the following manners:
    • Using a known and valid absolute URL: ![alt-text](http://foo.com/image.jpg)
      File URLs are not supported.
    • By letting the editor create the markup using the dedicated tool (Embed Image). The resulting markup must not be changed.

Type Or … to Get
*Italic* _Italic_ Italic
**Bold** __Bold__ Bold
# Heading 1 Heading 1
=========

Heading 1

## Heading 2 Heading 2
---------

Heading 2

[Link](http://a.com) [Link][1]
⋮
[1]: http://b.org
Link

![alt-text](http://url/a.png){width=100 height=150}

NOTE: the {width=100 height=150}
size specification is optional, as is the alt-text. The square brackets are mandatory.

NOTE: no blank character between closing paranthesis and opening curly bracket.

![Image][1]
⋮
[1]: http://url/b.jpg

NOTE: this variant does not support
size specification.

> Blockquote  
Blockquote

* List
* List
* List

- List
- List
- List

  • List
  • List
  • List

1. One
2. Two
3. Three

1) One
2) Two
3) Three

  1. One
  2. Two
  3. Three
Horizontal Rule

---
Horizontal Rule

***
Horizontal Rule
`Inline code` with backticks   Inline code with backticks
```
# code block
print '3 backticks or'
print 'indent 4 spaces'
```
····# code block
····print '3 backticks or'
····print 'indent 4 spaces'
# code block
print '3 backticks or'
print 'indent 4 spaces'
| Table Header 1| Table Header 2|
|---------------|---------------|
| Table Cell 11 | Table Cell 12 |
| Table Cell 21 | Table Cell 22 |
 
Table Header 1Table Header 2
Table Cell 11Table Cell 12
Table Cell 21Table Cell 22