How to Contribute

This site is a community-driven effort to document the lore of The Isle. Our goal is to create a single, centralized source of truth for the game's deep and evolving story. This guide explains how you can help.

---

How to Propose a Change

This wiki is built on a "Git-based" workflow, which is simple. You don't need to know any code.

At the bottom of every page, you will see this link:

"Propose a change to this page"

1. Click It: This link will take you directly to the GitLab page for that specific file.
2. Edit the File: GitLab has a built-in text editor. You can make your changes (fix a typo, add new info) right in your browser.
3. Propose Changes: When you're done, add a simple message explaining what you changed (e.g., "Fixed typo on AUGUSTUS") and submit it.

This sends a "Merge Request" to the site maintainers. They will review the change, and if approved, it will be automatically added to the live website.

---

Markdown Formatting Guide

This site uses Markdown with VitePress extensions. Below is everything you need to know to format your contributions.

---

Text Formatting

Bold and Italic

Syntax:

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

Creates:

Bold Text
Italic Text
Bold and Italic
Strikethrough

---

Headings

Syntax:

# Heading 1 (Page Title)
## Heading 2 (Main Section)
### Heading 3 (Sub-Section)
#### Heading 4
##### Heading 5
###### Heading 6

Creates:

Heading 1 (Page Title)

Heading 2 (Main Section)

Heading 3 (Sub-Section)

Heading 4

Heading 5

Heading 6

TIP

Use only one H1 (#) per page as the page title. Use H2 (##) for main sections.

---

Links

External Links

Syntax:

[Link Text](https://docs.apolloterminal.net)

Creates:

Link Text

Internal Links

Syntax:

[Core Concepts](/core-concepts)
[Known Assets](/known-assets)

Creates:

Core Concepts
Known Assets

---

Lists

Unordered Lists

Syntax:

* Item one
* Item two
  * Nested item
  * Another nested item
* Item three

Creates:

• Item one
• Item two
  • Nested item
  • Another nested item
• Item three

Ordered Lists

Syntax:

1. First step
2. Second step
3. Third step
   1. Sub-step
   2. Another sub-step

Creates:

1. First step
2. Second step
3. Third step
   1. Sub-step
   2. Another sub-step

Task Lists

Syntax:

- [x] Completed task
- [ ] Incomplete task
- [ ] Another incomplete task

Creates:

• [x] Completed task
• [ ] Incomplete task
• [ ] Another incomplete task

---

Blockquotes

Syntax:

> "They're unfortunate and necessary."
> — Developer Quote

> Multi-line quotes
> can span multiple lines
> like this.

Creates:

"They're unfortunate and necessary." — Developer Quote

Multi-line quotes can span multiple lines like this.

---

Code

Inline Code

Syntax:

Use `inline code` for file names, commands, or short code snippets.

Creates:

Use inline code for file names, commands, or short code snippets.

Code Blocks

Syntax:

```javascript
function example() {
  return "Hello World";
}
```

Creates:

function example() {
  return "Hello World";
}

Syntax with line highlighting:

```js {2-3}
function example() {
  const highlighted = "These lines";
  const areHighlighted = "are highlighted";
  return highlighted + areHighlighted;
}
```

---

Tables

Syntax:

| Asset Name | Type | Status |
|------------|------|--------|
| AUGUSTUS | Strain | Active |
| MATRIARCH | Strain | Deceased |
| Replicator | AI | Unknown |

Creates:

Asset Name	Type	Status
AUGUSTUS	Strain	Active
MATRIARCH	Strain	Deceased
Replicator	AI	Unknown

Table Alignment

Syntax:

| Left Aligned | Center Aligned | Right Aligned |
|:-------------|:--------------:|--------------:|
| Left | Center | Right |
| Text | Text | Text |

Creates:

Left Aligned	Center Aligned	Right Aligned
Left	Center	Right
Text	Text	Text

---

Custom Containers

VitePress provides special containers to highlight different types of information.

Info Container

Syntax:

::: info
This is for helpful, side-note information or additional context.
:::

Creates:

INFO

This is for helpful, side-note information or additional context.

Tip Container

Syntax:

::: tip Community Theory
This is for community theories, gameplay tips, or speculation that has some evidence.
:::

Creates:

Community Theory

This is for community theories, gameplay tips, or speculation that has some evidence.

Warning Container

Syntax:

::: warning Unconfirmed
Use this for **speculation** or unconfirmed lore. Information here may change.
:::

Creates:

Unconfirmed

Use this for speculation or unconfirmed lore. Information here may change.

Danger Container

Syntax:

::: danger Non-Canon
Use this for **deconfirmed** or outdated lore that is no longer considered canon.
:::

Creates:

Non-Canon

Use this for deconfirmed or outdated lore that is no longer considered canon.

Details (Collapsible)

Syntax:

::: details Click to expand
This content is hidden by default and can be expanded by clicking.
Great for long quotes, spoilers, or supplementary information.
:::

Creates:

Click to expand

This content is hidden by default and can be expanded by clicking. Great for long quotes, spoilers, or supplementary information.

---

Images

Syntax:

![Alt text description](/path/to/image.png)
![Isle Logo](https://example.com/logo.png)

With caption using HTML:

<figure>
  <img src="/path/to/image.png" alt="Description">
  <figcaption>This is a caption for the image</figcaption>
</figure>

---

Horizontal Rules

Syntax:

---

Creates:

---

---

Emojis

Syntax:

:tada: :rocket: :warning: :information_source:

Creates:

🎉 🚀 ⚠️ ℹ️

Full emoji list

---

Escaping Characters

If you need to display special Markdown characters literally, use a backslash \:

Syntax:

\* Not a bullet point
\# Not a heading
\[Not a link\]

Creates:

* Not a bullet point
# Not a heading
[Not a link]

---

Line Breaks

To create a line break without starting a new paragraph:

Syntax:

First line  
Second line (two spaces at end of first line)

Or use HTML:
First line<br>Second line

---

Advanced: Badges

Syntax:

<Badge type="info" text="New" />
<Badge type="tip" text="Updated" />
<Badge type="warning" text="Beta" />
<Badge type="danger" text="Deprecated" />

Creates:

NewUpdatedBetaDeprecated

---

Best Practices

Writing Guidelines

• Be concise: Keep explanations clear and to the point
• Cite sources: When possible, link to developer statements or in-game evidence
• Use containers: Highlight speculation vs. confirmed lore
• Stay neutral: Present theories without bias
• Update regularly: Mark outdated information clearly

---

Need Help?

If you're unsure about formatting or have questions about contributing, you can:

• Check the VitePress Markdown documentation
• Review existing pages for examples
• Open an issue on the GitLab repository for guidance

Thank you for contributing to the Apollo Docs project!