Markdown
Markdown syntax will automatically be converted into HTML when distributing from this.kiji.is domain.
Header
By adding # in the beginning of line, this will become a header. The number of # represent the level of header. You can add six #s at maximum.
# Header of level 1 ## Header of level 2 ... ###### Header of level 6
The above will be converted to HTML as the following:
<h1>Header of level 1</h1>
<h2>Header of level 2</h2>
...
<h6>Header of level 6</h6>
Paragraph
Paragraph can be divided by blank line.
This is the first paragraph. There are two sentences. This is the second paragraph. There are also two sentences. This is the third paragraph. There are also two sentences.
The above will be converted to HTML as the following:
<p>This is the first paragraph. There are two sentences.</p>
<p>This is the second paragraph. There are also two sentences.</p>
<p>This is the third paragraph. There are also two sentences.</p>
Line break
Line break will be ignored thus you cannot insert line break. In the Standard Markdown syntax, it allows you to insert line break with 2x half-width spaces, but nor. Markdown syntax do not support it.
Emphasis
Strings enclosed in *(one asterisk) or _(one underscore) will be displayed emphasized italic. Strings enclosed in **(two asterisks) or __(two underscores) will be displayed as strongly emphasized italic. Emphasis can be nested.
*emphasis* OR _emphasis_
The above will be converted to HTML as the following:
<em>emphasis</em> OR <em>emphasis</em> <strong>strong emphasis</strong> OR <strong>strong emphasis</strong>
Strikethrough
Strings enclosed in ~~(two tildes) will be displayed strikethrough.
~~Strikethrough~~
The above will be converted to HTML as the following:
<del>Strikethrough</del>
Link
Link can be written as [link text](link address).
[link to example](http://www.example.com/)
The above will be converted to HTML as the following:
<a href="http://www.example.com/">link to example</a>
List
By adding either *, +, - in the beginning of line, this will become the list of Disc type(no sorting). You need to add half-width space after *, +, -. Additionally, you need to add blank lines before and after the list. By adding two half-width spaces in the beginning of line, you can add indent. In the Standard Markdown syntax, you can create Decimal type(sorted) list by adding “numbers.” In the beginning of line, but nor. Markdown syntax do not support it.
Here’s the example of the list:
* Coffee * Tea - Earl Grey - Assam + Milk
The above will be converted to HTML as the following:
<ul>
<li>Coffee<li>
<li>Tea>
<ul>
<li>Earl Grey</li>
<li>Assam</li>
</ul>
</li>
<li>Milk</li>
</ul>Quotation
By adding > in the beginning of line, the line will become quotation line. You need to add half-width space after >. Additionally, you need to add blank lines before and after the quotation line.
> This text is the first line of the quotation. > This text is the second line of the quotation.
The above will be converted to HTML as the following:
<p> This text is the first line of the quotation. This text is the second line of the quotation. </p> </blockquote>
You can include references for the quotations with or without the URLs
> This text is the first line of the quotation. > This text is the second line of the quotation. > cite: [name of source](http://example.com)
The above will be converted to HTML as the following:
<blockquote> <p>This text is the first line of the quotation.;/p> <p>This text is the second line of the quotation.</p> <footer> <p><cite><a href="http://example.com">[name of source](http://example.com)</a></cite></p> </footer> </blockquote>
Enclosed
Lines enclosed in ~~~ will be displayed to the web page as enclosed.
~~~ This text is the first line enclosed. This text is the second line enclosed. ~~~
The above will be converted to HTML as the following:
<div> <p>This text is the first line enclosed.</p> <p>This text is the second line enclosed.</p> </div>
Preformatted Text
Lines enclosed in ``` will be displayed in a fixed-width font, and it preserves both spaces and line breaks.
``` This text is the first line preformatted. This text is the second line preformatted. ```
The above will be converted to HTML as the following:
<pre> This text is the first line preformatted. This text is the second line preformatted. </pre>
Ruled line
The line with more than three *(asterisks), -(hyphens), _(under scores) and half-width spaces will be regarded as ruled line.
******
The above will be converted to HTML as the following:
<hr />
Embedding images
In order to embed images, you need to upload the images with contentsholder/ images.upload API in prior. You can write [[image]](imageID), by utilizing image IDs retrievable from the response of that API. This Markdown is nor. original syntax which is unavailable in the Standard Markdown syntax.
Here’s an example to embed the image with image ID "2345678":
[[image]](2345678)
The above will be converted to HTML as the following. Alt always contain “image”.
<img src="https://img.nordot.jp/ch/images/2345678/origin_1.jpg" alt="image">
Embedding external videos
You can embed videos. This Markdown is nor. original syntax and not available in the Standard Markdown syntax. Right now we are compatible with YouTube and Vimeo.
YouTube example
[[embed-youtube]](https://www.youtube.com/watch?v=Sq5QW3YqipM)
Vimeo example
[[embed-vimeo]](https://vimeo.com/145667721)
BrightCove example
[[embed-brightcove]](http://players.brightcove.net/4373551972001/rJeyg92aW_default/index.html?videoId=5662917081001)
Embedding SNS posts
You can embed Tweets or other SNS posts. This Markdown is nor. original syntax and not available in the Standard Markdown syntax. Right now we are compatible with Twitter, Facebook, and Instagram.
Twitter example
[[embed-twitter]](https://twitter.com/Twitter/status/863846426383704064)
Facebook example
[[embed-facebook]](https://www.facebook.com/Engineering/posts/10155225879772200)
Instagram example
[[embed-instagram]](https://www.instagram.com/p/BUIkhi0jpyj/)
Embedding OGP contents
You can embed web pages’ OGP contents. This Markdown is nor. original syntax and not available in the Standard Markdown syntax.
Here’s an example with a page “https://nordot.app/1234567".
[[embed-page]](https://nordot.app/1234567)
Escape
In order to display special characters often used in the Markdown syntax, you need to insert \ just before the special characters.
\ ` * _ {} [] () # + - . ! < >