PSRay PSRay
Sign in Sign in

PSRay Markdown

Markdown writing guide

Write clear trophy guides with familiar Markdown and PSRay's collapsible, callout, step and spoiler blocks.

Markdown basics

These familiar forms work in every trophy tip.

Tips automatically generate a table of contents from H1–H4 headings. Follow the content hierarchy and do not use headings merely to enlarge text.

Headings (H1–H4)

# H1
## H2
### H3
#### H4
Result

H1

H2

H3

H4

Lists

- Item
- Item

1. First
2. Second
Result
  • Item
  • Item
  1. First
  2. Second

Links

[CommonMark](https://commonmark.org)
Result

CommonMark

Emphasis

**Bold** and *italic* and ~~strike~~
Result

Bold and italic and strike

Task lists

- [x] Complete
- [ ] Remaining
Result

Quotes

> A useful note
> Supporting details continue here.
> The final line stays in the same quote.
Result

A useful note
Supporting details continue here.
The final line stays in the same quote.

Code

`inline code`

```
code block
```
Result

inline code

code block

Images

Images always appear as standalone blocks for readable guides and long-form posts. Add Pandoc attributes immediately after an image to set its size. Setting only width or height preserves its intrinsic ratio; setting both uses the requested dimensions. Values are pixels from 1 to 4096.

Images

![PSRay Logo](/logo.svg)

PSRay Logo

Set width

![PSRay Logo](/logo.svg){width=48}

PSRay Logo

Set height

![PSRay Logo](/logo.svg){height=88}

PSRay Logo

Set width and height

![PSRay Logo](/logo.svg){width=112 height=48}

PSRay Logo

Text formatting

Select text in the editor, then apply a background highlight, colored underline, allow-listed text color or text size.

Marker

This whole sentence, while==Important text== is followed by ordinary text.

This whole sentence, whileImportant text is followed by ordinary text.

Text color

[Important text]{color=red}

Important text

Text size

This whole sentence, while [Small]{size=small} [Large]{size=large} [Extra large]{size=xlarge}

This whole sentence, while Small Large Extra large

Color line

This whole sentence, while[Slate]{underline=slate} is followed by ordinary text.
[Red]{underline=red} [Orange]{underline=orange} [Yellow]{underline=yellow} [Green]{underline=green} [Blue]{underline=blue} [Purple]{underline=purple} [Pink]{underline=pink}

This whole sentence, whileSlate is followed by ordinary text.
Red Orange Yellow Green Blue Purple Pink

Combining and nesting

Pandoc-style syntax keeps attributes for the same range in one attribute block. Nest only when the text ranges differ. Attribute order does not affect the result.

Combine the same range

Recommended

When color, size and underline apply to the same text, keep the attributes together.

[Important text]{color=red size=large}

Important text

Nest different ranges

Use nesting

The outer size applies to all text while the inner color applies only to part of it.

[This whole sentence, while [this part is red]{color=red}]{size=large}

This whole sentence, while this part is red

Repeat nesting for one range

Not recommended

This parses correctly but is verbose; use a single attribute block instead.

[[Important text]{color=red}]{size=large}

Important text

Advanced blocks

Start a block with ::: and finish it with another ::: line.

Collapsible details

Hide supporting details behind a clickable heading.

::: details
Source
::: details Collectible location
Break the crate on the right after passing through the castle gate to obtain the **collectible**.
:::
Result
Collectible location

Break the crate on the right after passing through the castle gate to obtain the collectible.

Information

Highlight useful background information.

::: info
Source
::: info Before you begin
This challenge becomes available after **Chapter 3** and has a recommended level of 20.
:::
Result
Before you begin

This challenge becomes available after Chapter 3 and has a recommended level of 20.

Tip

Call attention to a practical recommendation.

::: tip
Source
::: tip A reliable strategy
Dodge just after the boss finishes attacking to create a safe opening for a counterattack.
:::
Result
A reliable strategy

Dodge just after the boss finishes attacking to create a safe opening for a counterattack.

Warning

Warn readers about something important.

::: warning
Source
::: warning Missable item
Open the chest before leaving the area. You cannot return after starting the next chapter.
:::
Result
Missable item

Open the chest before leaving the area. You cannot return after starting the next chapter.

Danger

Emphasize a serious risk or irreversible action.

::: danger
Source
::: danger Save data warning
Confirming this choice locks your route. Create a manual save before continuing.
:::
Result
Save data warning

Confirming this choice locks your route. Create a manual save before continuing.

Titled task list

Group tasks in a card with a title and live completion count.

::: checklist
Source
::: checklist Boss battle preparation
- [x] Restock healing items
- [ ] Equip resistance gear
- [ ] Unlock the shortcut
:::
Result
Boss battle preparation1 / 3

Steps

Present a numbered walkthrough.

::: steps
Source
::: steps
1. Defeat every enemy in the courtyard
2. Press the switch behind the statue
3. Enter the treasure room through the open door
:::
Result
  1. Defeat every enemy in the courtyard
  2. Press the switch behind the statue
  3. Enter the treasure room through the open door

Spoiler area

Collapse spoiler content containing multiple paragraphs or lists.

::: spoiler
Source
::: spoiler Ending requirement
Collect every key before opening the final door to reach the **secret ending**.
:::
Result
Ending requirement

Collect every key before opening the final door to reach the secret ending.

Inline spoiler

Use the inline syntax shown below for a short phrase within a sentence. Its text is obscured until clicked.

|| ... ||
Source
After defeating the final boss, ||the secret ending is unlocked|| and the related trophy is awarded.
Result

After defeating the final boss, and the related trophy is awarded.

Nesting blocks

Different advanced blocks can be nested. Keep each opening and closing marker on its own line so the structure stays clear.

:::: details Optional title
::: warning Warning
Content
:::
::::

Whole-tip, block and inline spoilers

Choose the smallest spoiler boundary that protects readers.

  • Use the publish form's spoiler switch when the entire tip gives away hidden information.
  • Use a ::: spoiler block to hide multiple paragraphs or a list.
  • Use the inline syntax shown below for a short phrase within a sentence. Its text is obscured until clicked.