Writing help

Markdown guide

AI-generated help: This guide is intended to help you present your own posts. Your ideas, research, experience, and final writing should still be your own.

Quick example

# My post

This has **bold text**, *italic text*, and a [useful link](https://example.com).

## What I learned

- First point
- Second point
- Third point

Headings and page links

Headings automatically receive linkable IDs. Their links use lowercase words separated by hyphens.

[Jump to results](#results)

## Results

For example, ## Final Results becomes #final-results. Duplicate headings receive endings such as -2.

Table of contents

Add [toc] on its own line to build a collapsible table of contents from the headings. It begins open and can be closed by the reader.

[toc]

# My guide

## Introduction
## Instructions
## Conclusion

Use [toc collapsed] when it should begin closed.

Collapsible sections

Details blocks are useful for optional explanations, answers, and other lengthy material.

:::details Show the long explanation
This content is hidden until opened.

Normal **Markdown** still works inside.
:::

Both markers must start on their own lines. Do not hide essential warnings or required instructions inside a collapsed section.

Lists and tasks

- First item
- Second item
  - Nested item

1. First step
2. Second step

- [x] Finished task
- [ ] Unfinished task

Include a space after each hyphen or number, and leave an empty line before a list.

Tables

| Feature | Syntax | Approval |
|:---|:---:|---:|
| Figure | [figure 1] | No |
| Embed | [embed 1] | Yes |

Colons control column alignment. Wide tables scroll horizontally on smaller screens.

Quotes and code

> A quotation or important note.

Use `inline code` for short commands.

```js
console.log("Use a fenced block for longer code");
```

Figures and embeds

Uploaded media is inserted with [figure 1], [figure 2], and so on. Admin-reviewed custom embeds use [embed 1] in the same way.

Text before the media.

[figure 1]

Text between the items.

[embed 1]

Text after the embed.

Good writing habits

  • Use descriptive headings in a logical order.
  • Keep paragraphs reasonably short.
  • Use meaningful link text rather than “click here”.
  • Do not communicate meaning through colour alone.
  • Preview tables and long code blocks on a narrow screen.
  • Use formatting to support the writing, not distract from it.