Markdown Mode

Snow Flower Text supports Markdown notation. By switching the grammar to Markdown mode, you can write while checking the conversion result with fast real-time preview. After writing, you can easily export to HTML, PDF, EPUB etc document format. Snow Flower Text is compatible with Markdown’s standard specification CommonMark, plus many extensions, including those commonly used on Github and other sites.

These functions can be started using Snow Flower Text installation without additional installation.

This HTML document is created using Markdown mode of Snow Flower Text. Markdown mode can be used widely for simple private notes and open documents.

This document explains how to use CommonMark’s extension function which is the standard specification of Markdown.

What is Markdown

Markdown is one of lightweight markup languages for describing documents. Originally developed to generate HTML from documents written in plain text format easily.
Markdown notation has the following features.

  • Anyone can write with simple notation
  • Anyone can read with natural notation
  • Text can be structured

CommonMark Extensions

Markdown is a tool released by John Gruber in 2004.
The Markdown notation was widely adopted by the software community due to its simplicity, but the syntax has not been revised since v1.0.1 (2004), so many developers are developing situations of variant tools, CommonMark Standardization is in progress.

MarkDown is a simple macro that makes it easy to write HTML articles, and complicated things are supposed to use HTML tags. CommonMark still has not enough coverage for general use. The user wants functions such as “table”, “definition list”, “footnote”.

Markdown principle

Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions

Snow Flower Text keeps “Markdown principle” and provides CommonMark extension according to these requests.

Strikethrough

Strikethrough style can be used to indicate that the enclosed text is being deleted.
Strikethrough style encloses text in the target range with ~~ (tilde).

~~Strikethrough~~

Strikethrough

Definition List

Definition lists are made of terms and definitions of these terms, much like in a dictionary.
The definition list is described as follows.

Term A
: description

Term B
: description

The display will be as follows.

Term A

description

Term B

description

Task list

The task list is a list specialization. It is similar to a list and can be nested like a list.

* [ ] todo
* [x] done
* [x] done

The display will be as follows.

  •  todo
  •  done
    •  done

Table

Write the table as follows.

| Header1 | Header2     |
| ------- | ----------- |
| Apple | Lorem ipsum dolor sit amet |
| Orange | Lorem ipsum dolor sit amet |
| Banana | Lorem ipsum dolor sit amet |
Header1Header2
AppleLorem ipsum dolor sit amet
OrangeLorem ipsum dolor sit amet
BananaLorem ipsum dolor sit amet

Write the column to be right-aligned as follows.

| Header1 | Header2     |
| -------:| -----------:|
| Apple | Lorem ipsum dolor sit amet |
| Orange | Lorem ipsum dolor sit amet |
| Banana | Lorem ipsum dolor sit amet |
Header1Header2
AppleLorem ipsum dolor sit amet
OrangeLorem ipsum dolor sit amet
BananaLorem ipsum dolor sit amet

You will understand those with good intuition. Write the centering as follows.

| Header1 | Header2     |
|:-------:|:-----------:|
| Apple | Lorem ipsum dolor sit amet |
| Orange | Lorem ipsum dolor sit amet |
| Banana | Lorem ipsum dolor sit amet |
Header1Header2
AppleLorem ipsum dolor sit amet
OrangeLorem ipsum dolor sit amet
BananaLorem ipsum dolor sit amet

Write the join of the cells of the table as follows.

| Header1 | Header2     |
|:-------:|:-----------:|
| Apple | Lorem ipsum dolor sit amet |
| Orange | Lorem ipsum dolor sit amet |
| Banana ||
Header1Header2
AppleLorem ipsum dolor sit amet
OrangeLorem ipsum dolor sit amet
Banana

If you want to manually insert line breaks in cells, insert <br> like body text.

| Header1 | Header2     |
| ------- | ----------- |
| Apple | Lorem<br> ipsum dolor sit amet |
| Orange | Lorem ipsum<br> dolor sit amet |
| Banana | Lorem ipsum dolor<br> sit amet |
Header1Header2
AppleLorem
ipsum dolor sit amet
OrangeLorem ipsum
dolor sit amet
BananaLorem ipsum dolor
sit amet
Tip

Have you taken the time to spare space adjustment in the table description?
Snow Flower Text supports markdown Pretty format. Edit >> Format menu, It is automatically formatted and looks beautiful.

Table of contents

For long documents you will want a table of contents. In such a case, write [TOC] at the place you want to insert the table of contents.

[TOC]

The headings of documents are gathered automatically and the table of contents is expanded in the order of description. It does not happen that the heading and the table of contents do not match. No effort is needed to maintain consistency of the table of contents.

Footnotes

Footnotes work mostly like reference-style links. A footnote is made of two things: a marker in the text that will become a superscript number; a footnote definition that will be placed in a list of footnotes at the end of the document. A footnote looks like this:

Footnote 1 link[^1].

And do not forget to write a pair of footnote definitions as follows.

[^1]: Footnote description

Admonition

Using Admonition effectively expresses sections such as information and warnings with icon and color styles.

For example, if you want to inform a reader of alertness in a document, write it as follows.

!!! warning

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

The display will be as follows.

Warning

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

If you want to customize the title of Admonition, write it as follows.

!!! warning "Important Notice"

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
Important Notice

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

You can specify the following types of Admonition.

  • info
  • tip
  • success
  • question
  • warning
  • success
  • failure
  • danger
  • bug
  • example
  • quote
!!! info
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! tip
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! success
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! question
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! warning
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! failure
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! danger
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! bug
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! Example
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
!!! Quote
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

These are displayed as follows.

Info

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Tip

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Success

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Question

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Warning

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Failure

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Danger

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Bug

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Example

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Quote

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

Relate documents

References