Skip to main content

Markdown Formatting

Modrinth's text fields, including project bodies and version changelogs, use GitHub Flavored Markdown.

As the full GFM spec is too large to read comfortably and GitHub's formatting guide contains features not included in GFM, this page serves as a quick reference for what types of formatting can be used on Modrinth.

Important

The displayed features may not reflect the actual style used on Modrinth.

Basic formatting​

**Bold**
*Italic*
***Bold and Italic***
~~Strikethrough~~

Code blocks​

`single-line code block`

```
multi
line
code
block
```
tip

You can add a language (e.g. java) after the first three backticks to add code highlighting to the code block.

Block quotes​

> Some Quote
> > Nested Quote
https://modrinth.com
[Embedded link](https://modrinth.com)
[Embedded link with title](https://modrinth.com 'Title')
[Reusable link]

<!-- (end of document) -->
[Reusable link]: https://modrinth.com

Images​

![REPLACE ME WITH YOUR ALT TEXT](https://cdn.modrinth.com/modrinth-new.png)
![REPLACE ME WITH YOUR ALT TEXT](https://cdn.modrinth.com/landing-new/landing.webp 'REPLACE ME WITH AN OPTIONAL TITLE')
<!-- Use the Gallery tab on your project for image hosting! -->
danger

Alt text is very important to use. Your project may be rejected if you don't add alt text! Refer to section 2.1 of Modrinth's content rules.

Headings​

# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header
caution

Do not overuse headers, but do not underuse them either! Headers are meant to delineate different sections of content in your description. Entire sentences should never be inside a header.

Lists​

Unordered Lists​

- Entry 1
- Entry 2
    - Entry 2.1
    - Entry 2.2
- Entry 3

Ordered Lists​

1. Entry 1
2. Entry 2
    1. Entry 2.1
    2. Entry 2.2
3. Entry 3

Tables​

| Title 1             | Title 2               | Title 3              |
|---------------------|:---------------------:|---------------------:|
| Cell 1:1            | Cell 1:2              | Cell 1:3             |
| Cell 2:1            | Cell 2:2              | Cell 2:3             |
| Cell 3:1            | Cell 3:2              | Cell 3:3             |
| Left-aligned column | Center-aligned column | Right-aligned column |
note

Note the colons used in the second line of the table to change the column alignment.

Details (spoilers)​

<details>
<summary>Click me!</summary>

You clicked me!

</details>
caution

Markdown only works properly in details tags if there is at least one empty line between HTML and Markdown content.

Newlines​

This sentence will have an empty line

between its two segments.

---

This sentence will all
go on one line.

---

This sentence will be\
split into two lines

---

This sentence will also be  <!-- there are two spaces after this line -->
split into two lines

YouTube iframes​

To use a YouTube iframe, copy-paste the following into your description:

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/REPLACE_THIS_TEXT_HERE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Then, replace the text that says REPLACE_THIS_TEXT_HERE with the 11-character code that follows /watch?v= in the YouTube video URL. For example, it should look something like d1YBv2mWll0. Remove any query parameters like si=randomText or wmode=transparent.