Locale: en-US
Page: Markdown Syntax

Page Type:

Alias Page To:

Page Border:

Table of Contents:

Title:

Author:

Meta Robots:

Meta Description:

Meta Properties (such as Open Graph)

One line per property in format: name|content

Header Page Name:

Footer Page Name:

: A wiki group can be set to draw its pages with the markdown engine instead
of the mediawiki-style engine. This page describes the markdown a group
drawn with that engine understands. The flavor is close to the markdown used
on GitHub. If your group instead uses the mediawiki-style engine, see the
[[Syntax|Yioop Wiki Syntax]] page.

: A group's engine is chosen with the render engine dropdown in the group's
settings. The two engines share the same tools for adding search boxes,
resources, forms, and a table of contents, so the last sections below apply
to both; only the everyday text formatting differs.

==Headings==
: Headings are written with one to six number signs at the start of a line,
one sign per level:

<pre>
<nowiki>
# Level 1
## Level 2
### Level 3
#### Level 4
##### Level 5
###### Level 6
</nowiki>
</pre>

: The two top levels can also be written by underlining a line of text. A row
of equals signs makes a level 1 heading and a row of hyphens makes a level 2
heading:

<pre>
<nowiki>
Level 1
=======

Level 2
-------
</nowiki>
</pre>

: Each heading is given an id built from its text, so it can be linked to and
picked up by the table of contents.

==Paragraphs and Line Breaks==
: One blank line separates one paragraph from the next. A single new line
inside a paragraph is treated as an ordinary space, so a paragraph can be
wrapped over several lines in the editor and still read as one paragraph. To
force a line break without starting a new paragraph, end a line with two
spaces:

<pre>
<nowiki>
first line  
second line
</nowiki>
</pre>

==Emphasis==
: Text can be made italic, bold, both, or struck through:

<pre>
<nowiki>
*italic* or _italic_
**bold** or __bold__
***bold and italic***
~~struck through~~
</nowiki>
</pre>

: A single star or underscore around a run of text makes it italic, a pair
makes it bold, and three makes it both. A pair of tildes strikes text
through.

==Blockquotes==
: A line beginning with a greater-than sign is quoted. Putting the sign in
front of several lines in a row quotes them as one block:

<pre>
<nowiki>
> a quoted line
> and another
</nowiki>
</pre>

==Horizontal Rules==
: A line on its own made of three or more hyphens, stars, or underscores
draws a horizontal rule:

==Lists==
: A bulleted list is written by starting each item with a hyphen, a star, or
a plus sign. A numbered list is written by starting each item with a number
and a period. A list is nested inside another by indenting its items:

===Bulleted Lists===
<pre>
<nowiki>
- Item 1
  - Subitem 1
  - Subitem 2
    - Sub-subitem 1
- Item 2
- Item 3
</nowiki>
</pre>

===Numbered Lists===
<pre>
<nowiki>
1. Item 1
   1. Subitem 1
   2. Subitem 2
2. Item 2
3. Item 3
</nowiki>
</pre>

===Definition Lists===
: A definition list is written with the term on a line of its own and each
of its meanings beneath it after a colon. A term may carry more than one
meaning:

<pre>
<nowiki>
Term 1
: Definition of Term 1
: A second definition of Term 1

Term 2
: Definition of Term 2
</nowiki>
</pre>

===Keeping Several Lines Together===
: A definition's meaning is ordinarily only as much as fits on its own
line, since the line after it begins something new. Where you want a list,
or a second paragraph, inside one, the same-unit mark says that the lines
it holds are all the content of the thing being written, however many
there are. What is inside is read as ordinary markup, so it may hold
lists, paragraphs and further marks.

<pre>
<nowiki>
Voting
: {{same-unit Whether members may vote on a post.
- No Voting - posts carry no vote.
- Vote Up - a member may vote a post up only.

A vote counts once per member per post. }}
</nowiki>
</pre>

: Reading stops where the braces balance rather than at the end of a line,
so the mark may run over as many lines as you need. Leave a blank line
before a paragraph that is to stand on its own; without one, a line
following a list item continues that item instead.

==Code==
: A short piece of code inside a sentence is written between dollar signs.
The same notation is used for a short piece of mathematics, which is drawn
with MathJax:

<pre>
<nowiki>
the call $printf()$ prints text, and $x^2 + y^2$ is a sum of squares
</nowiki>
</pre>

: A whole block of code is written in one of two ways. The first is to fence
it between two lines of three backticks; a word after the opening fence names
the language for coloring:

<pre>
<nowiki>
```php
$total = 0;
foreach ($items as $item) {
    $total += $item;
}
```
</nowiki>
</pre>

: The second is to indent every line of the block by four spaces:

<pre>
<nowiki>
    $total = 0;
    foreach ($items as $item) {
        $total += $item;
    }
</nowiki>
</pre>

==Links==
: A link is written by putting the link text in square brackets and the
address right after it in parentheses. An optional title in quotes inside the
parentheses becomes the link's hover text:

<pre>
<nowiki>
[Yioop](https://www.seekquarry.com/)
[Yioop](https://www.seekquarry.com/ "The Yioop site")
</nowiki>
</pre>

: A web address written on its own between angle brackets becomes a link to
itself:

: When the same address is used more than once, it can be named once and
referred to by name. The name is written in a second set of square brackets
after the link text, and the address is given on its own line anywhere on the
page:

<pre>
<nowiki>
See the [Yioop site][home] and the [downloads][home] there.

[home]: https://www.seekquarry.com/
</nowiki>
</pre>

: To link to another wiki page in the same group, or to a page in a different
group, use the address of that page as the link's address.

==Images==
: An image is written like a link with an exclamation point in front. The
bracketed text becomes the image's alternative text, shown when the image
cannot be drawn:

<pre>
<nowiki>
![a red apple](apple.png)
</nowiki>
</pre>

: To show an image that has been uploaded to the page as a resource, use the
resource notation described in the "Adding Resources" section below.

==Footnotes==
: A footnote is written in two parts. A marker of the form a caret and a name
in square brackets is placed where the note should be referred to, and the
note's text is given on its own line, starting with the same marker and a
colon. The notes are gathered and drawn at the foot of the page:

<pre>
<nowiki>
Yioop is a search engine[^1] you can host yourself.

[^1]: It also serves as a wiki and a group discussion system.
</nowiki>
</pre>

==Tables==
: A table is written as rows of cells separated by vertical bars. The first
row is the heading row, and the row under it, made of hyphens, marks where
the heading ends and sets each column's alignment. A colon on the left of a
column's hyphens aligns it left, a colon on the right aligns it right, and a
colon on both sides centers it:

<pre>
<nowiki>
| Name  | Score | Note     |
|:------|------:|:--------:|
| Ann   |    90 | pass     |
| Bob   |     5 | retake   |
</nowiki>
</pre>

==Escaping==
: To show a character that markdown would otherwise treat as formatting, put
a backslash in front of it. For example, to show a star without starting
italics:

<pre>
<nowiki>
\*not italic\*
</nowiki>
</pre>

==Raw HTML==
: Unlike the mediawiki-style engine, the markdown engine does not pass raw
html through to the page; angle brackets typed into the text are shown as the
characters themselves. Use the markdown above, or the templates below, to
format a page.

==A Table of Contents==
: The same page setting that adds a table of contents to a mediawiki page
adds one to a markdown page, built from the level 2 and level 3 headings. The
setting is the table of contents checkbox in the page's settings, reached
from the gear link next to the page name in edit mode.

==Adding a Search Box==
: A site search box can be dropped into a markdown page with the same tag
used on a mediawiki page:

<pre>
<nowiki>
{{search:default|size:small|placeholder:Search Placeholder Text}}
</nowiki>
</pre>

: The tag has three parts separated by vertical bars. The first part names
the search index to use; default means the site's default index, and a
timestamp or the word mix can be used instead. The second part sets the size
of the box: small, medium, or large. The third part sets the grayed-out text
shown in the empty box.

==Adding Resources to a Page==
: Images, audio, video, and other files are attached to a page the same way
in both engines: by dragging them into the edit area, or with the select
resource link in the gray box under the edit area. Doing so adds a resource
tag to the page:

<pre>
<nowiki>
((resource:myphoto.jpg|A description of the photo))
</nowiki>
</pre>

: The full set of resource notations -- thumbnails, links to a resource's
own page, comma separated value files drawn as tables or charts, and QR codes --  work the same as on a mediawiki page. See the "Adding Resources to a
Page" section of the [[Syntax|Yioop Wiki Syntax]] page for the complete list.

==Templates, Forms, and Page Settings==
: The double-brace templates work the same in both engines. This includes the
toggle links that show and hide a block of text, the alignment and style
templates, and the full set of wiki form fields  --  text fields, text
areas, checkboxes, radio buttons, dropdowns, captchas, and secret ballots.
The page settings and page types  --  standard, page alias, media list,
presentation, share wall, url shortener, and template pages --  are also
shared. Because these do not use markdown's everyday text formatting, they
are documented once, on the [[Syntax|Yioop Wiki Syntax]] page, and apply
without change to a markdown page.