Want to format your text? You can with the Markdown syntax! While it’s not required, a few Markdown tips will transform minimally marked up plain text into well formatted documents.

Let’s start with the basics: headers and lists.

Basic Guide

Header

To make a header, use #  (pound key followed by a space). You must add a space after the # . You can add 1-6 consecutive #  to adjust the size of your header. 

Example:

# This is a <h1> tag
## This is a <h2> tag
### This is a <h3> tag
#### This is a <h4> tag
##### This is a <h5> tag
###### This is a <h6> tag

Lists

To make lists, use -  (hyphen and a space) or * (asterisks and a space) before each item. If you use numerals 1. the list will be ordered. By adding 4 spaces, you can make indentations. 

Example:

1. Apple
2. Peach
3. Pear

- Apple
    - Peach
        - Pear   

Emphasize

Not only can you make headers and lists, you can also emphasize words or phrases and embed links. 

Bold and Italics

Surround text with **  (2 asterisks) to bold text. Use *  (1 asterisk) for italics

Example:

Embed links

URLs are automatically converted to a hyperlink. You can create an inline link by wrapping link text in brackets, followed by the URL in parentheses.

Example:

[linktext](URL)

Code

Use backticks ` to highlight inline code such as file names or small code snippet.

Code Blocks

Wrap with ``` (3 backticks) or ~~~ (3 tildas) to syntax highlight your code.

To get the proper syntax highlight, append the programming language right after the opening backticks or tildas.

You can also use the filename and Kibela will detect which language is most appropriate for it. You can also set it explicitly with the format language:finename, for example ruby:Gemfile.

PlantUML

You can create PlantUML diagrams by setting the "language"  of your code block as {platuml}.

Note that you can set the code block language to plantuml  (without the {} bracket), but it's deprecated.

LaTeX

Use {latex}  to write mathematical equations that are supported by Mathjax. Wrap your code with $$  to embed the inlineMath into the text. 

HTML

If Markdown is not sufficient for your format, you can always write HTML. Please note that certain HTML tags are not available for use on Kibela. 

Attach Files

Images

You can drag and drop your image files directly into the Kibela editor. Images will be uploaded and inserted as plain HTML code, so you can tweak its width  and height.

Files other than images

Files other than images will be automatically converted into a clickable link. If uploading a PDF, you’ll be able to preview it directly in the article. 

Did this answer your question?