Markdown syntax

Titles #

Level 1 title (the title of the article). This must be completed in the metadata
Level 2 titles (titles of each section) are preceded by 2 #. For example: ## Introduction
Level 3 titles (subsections) are preceded by 3 #. For example: ### Mon titre de sous-section
And so on (level 4, 4 #, etc.).

Footnotes #

Footnotes can be in the body of the text (inline) or use a footnote number that refers to the bottom of the article.

Examples:

Here is my text^[An inline footnote.].

Will give:

Here is my text¹.

Or:

Here is my text[^2].

 [^2]: a footnote with a number and reference.

Will give:

Here is my text².

Italics and bold #

Italics can be created with _ before and after the word or expression in italics. For example:

Here is a _word_ in italics.

Will give:

Here is a word in italics.

Bold can be created with two ** before and after the word or expression in bold. For example:

Here is a **word** in bold.

Will give:

Here is a word in bold.

Images #

An image can be integrated into a document written in the Markdown markup language according to the following model:

An exclamation mark ! ;
Followed by square brackets [] containing the image description ;
Then parentheses () containing the image path or address.

Here is an image, in this case the logo for W3C (World Wide Web Consortium) :

And here is the corresponding markdown:

![W3C logo containing the letter W in blue, the digit 3 in blue and the letter C in black](https://upload.wikimedia.org/wikipedia/commons/thumb/5/5e/W3C_icon.svg/212px-W3C_icon.svg.png)

Important: images must be is PNG format (.png), this format is required for the PDF export.

Links #

The links can be created by using the following model:

The link, that is, the word or expression indicated as a link, with square brackets [];
And the target, the destination URL, with parentheses ().

Here is a link to a Wikipedia page, and the corresponding markers:

[a link to a Wikipedia page](https://en.wikipedia.org/wiki/Hyperlink)

Citations #

A citation can be semantically indicated using the following markup: a closing square bracket followed by a space at the beginning of a paragraph > . Here is a citation example:

Clicking on a hypertext or hyperlink allows navigation to another place on the page, another page or website that the author judges relevant. Source : Wikipedia

And here are the corresponding markers:

> Clicking on a hypertext or hyperlink allows navigation to another place on the page, another page or website that the author judges relevant.
> Source : [Wikipedia](https://en.wikipedia.org/wiki/Hyperlink)

Unbreakable space #

Unbreakable spaces are represented by a midpoint: ·. Example: How are you·? They can be added by typing Ctrl + Shift + Space.

It is also possible to use an unbreakable space in ASCII  .

Note that if your markdown source comes from the Pandoc DOCX (or ODT) conversion to markdown, unbreakable spaces will be conserved and presented in Stylo in the form of a midpoint.

Semantic Markup #

Semantic markup allows specifying the function of a word, an expression, or a paragraph.

Stylo allows free semantic markup: each author can define their own semantic structure according to their particular needs. It can then be implemented in export templates or custom style sheets (see the section Personalise your export).

The markdown syntax for semantic markup is as follows: [term to markup] {.category}.

For example: We can consider this [rupture]{.concept} emblematic of... identifies the term rupture as a concept.

The following markdown text:

Here is the [article's fundamental assertion]{.assertion}.

gives in HTML:

Here is the <span class="assertion"> article's fundamental assertion</span>

To markup an entire paragraph, one uses the following syntax:

::: {.assertion}

My paragraph that contains the article's assertion.

:::

Which gives in HTML:

<div class="assertion">
<p> My paragraph that contains the article's assertion.</p>
</div>

Stylo preview implements the display of the following semantic classes:

Assertion
Description
Example
Concept
Definition
Question
Epigraph
Dedication
Credits
Source

It is possible to mark up a textual element with many attributes. For example:


::: {.infogeo}

[Athens]{.ville id="https://www.wikidata.org/wiki/Q1524" gps="37.58.46N, 23.42.58E"} is the capital of Greece.

:::

gives in HTML:

<div class="infogeo">
<p><span id="https://www.wikidata.org/wiki/Q1524" class="ville" data-gps="37.58.46N, 23.42.58E">Athens</span> is the capital of Greece.</p>
</div>

It is also possible to use this semantic markup to structure the data in RDFa, as in these two examples:


Text author: [John Dewey]{property="dc:creator"}

gives in HTML:


<p>Text author: <span data-property="dc:creator">John Dewey</span></p>

Second example:


John Dewey is born on [20 October 1859]{property="dc:date"content="1859-10-20"}.

Gives in HTML:


<p>John Dewey is born on <span property="dc:date" content="1859-10-20">20 October 1859</span></p>

Tables #

Tables are created as follows

| Separates columns
A single line break separates the lines
A second line defines the column alignment:
- :-- aligns column to the right
- :-: aligns column to the centre
- --: aligns column to the left

For example, the syntax:

|Surname|First name|Birth date|Birthplace|Eye colour|
|:--|:--|:-:|:-:|--:|
|Bianchini|Francesco|3-1-1920|Scandicci|Blue|
|Dupont|Pierre|7-9-1989|Chicoutimi|Green|
|Gianna|Bienfaisant|9-10-2005|Florence|Brown|

Gives:

Surname	First name	Birth date	Birthplace	Eye colour
Bianchini	Francesco	3-1-1920	Scandicci	Blue
Dupont	Pierre	7-9-1989	Chicoutimi	Green
Gianna	Bienfaisant	9-10-2005	Florence	Brown