Markdown Guide

Markdown is a lightweight markup language that allows users to create formatted text using a plain-text editor. Archivium uses a slightly modified version of this language in comments, custom data values, and gallery image labels.

Item text, notes, story chapters and universe home pages are written with the Rich Text Editor instead, which supports many of the same shortcuts.

Here's the markdown syntax Archivium supports:

Basic Syntax

Headings

To create headings, use the # symbol followed by a space and the heading text. The number of # symbols determines the heading level (1 through 6).

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Paragraphs

Paragraphs are created by typing text without any special symbols. Separate paragraphs with a blank line.

This is the first paragraph.

This is the second paragraph.

Text Formatting

Bold

Wrap text with double asterisks **.

**This text is bold**

Italic

Wrap text with single asterisks * or single underscores _.

*This text is italicized*
_This text is also italicized_

Bold and Italic

Bold and italicized text can be combined.

***This text is bold and italic***
_**This text is also bold and italic**_

Lists

Unordered Lists

Use dashes - to create unordered lists. You can add sub-levels to the list by adding two spaces before a dash, allowing for nested lists.

- Item 1
- Item 2
  - Sub-item 2.1
  - Sub-item 2.2
    - Sub-item 2.2.1
    - Sub-item 2.2.2
  - Sub-item 2.3
- Item 3
- Item 4

Links and Images

Links

Create links using square brackets for the text and parentheses for the URL. Instead of providing a URL, you can also use the shortname of an item to link directly to it.

[This links to a website](https://www.example.com)
[This links to an item](@item-shortname)
[This links to an item in another universe](@universe-shortname/item-shortname)

Images

Images use the same syntax as links, but with an exclamation mark ! at the start.

![Alt text](https://www.example.com/image.jpg)

Special Characters

To display special Markdown characters (like *, _, and #), use a backslash \ to escape them.

\*This text is not italicized\*

Cheat Sheet

Custom Functions

Asides

Use the @aside command to create asides.

@aside

Content within the aside.

@aside-end