Skip to content

How to contribute

glitchingdocs is open to contributions from anyone. All you need is a GitLab account and basic Markdown knowledge — no coding required.

Quick way (edit on GitLab)

Every page has an Edit this page link at the bottom. Click it, make your changes, and submit a merge request.

Adding a new page

  1. Create a .md file in the right folder:

    • docs/movement/ — movement techniques
    • docs/clips/ — clips and showcase
    • docs/miscellaneous/ — misc mechanics
    • docs/tips/ — tips and tricks
  2. Name it with hyphens, no spaces: wall-hop.md, dance-clip.md

  3. Use this template:

markdown
---
title: Mechanic name
category: Movement
description: One sentence describing what this is.
rig: Both
---

# Mechanic name

Short description of what this is and why it matters.

<PageBadges />

## Video

<iframe width="100%" style="aspect-ratio:16/9;border-radius:10px;border:none"
  src="https://www.youtube.com/embed/VIDEO_ID" allowfullscreen></iframe>

## How to do it

1. Step one
2. Step two
3. Step three

## Notes

- Any extra context, variations, or gotchas.
- If the glitch is version-specific, mention that here.

> Found by **username**

Frontmatter fields

FieldValues
titleThe name of the mechanic
categoryMovement, Clips, Miscellaneous, Tips
descriptionOne sentence, shown on the browse page
rigR6, R15, or Both

Uploading a video

  1. Upload your clip to Streamable or YouTube (unlisted)
  2. For YouTube: copy the video ID from the URL — youtube.com/watch?v=ABC123 → ID is ABC123
  3. Paste into the embed: https://www.youtube.com/embed/ABC123
  4. For Streamable: use https://streamable.com/e/ABC123

Linking to other pages

You can link to other pages or tips inline like this:

md
Face a wall while [shiftlock](../tips/shiftlock) is enabled.

Guidelines

  • Keep descriptions beginner-friendly
  • Always include a video if you can find one
  • For glitches, mention whether it still works in the current version
  • Credit the finder with > Found by **username** at the bottom
  • Use lowercase filenames with hyphens

Open source, community maintained.