| name | description |
|---|---|
| wiki_editing | Instructions and conventions for editing the GnollHack Wiki Markdown pages and handling images. |
GnollHack Wiki Editing Guidelines
When editing or creating pages for the GnollHack Wiki, follow these conventions optimized for AI agents like Gemini 3.5 Flash.
1. File and Heading Structure
-
Page Titles: The wiki automatically uses the filename (without
.md) as the page title. Never start a page with anH1(#) orH2(##) heading that is identical to the page's name (the filename without extension). In such cases, omit the heading completely, as it is implied and provided to the page from the filename. Use a singleH1heading (#) on the very first line ONLY if you need a custom title that differs from the filename (e.g., incorrect filename casing or special pages like the home page). In most cases, an H1 is not needed. -
Section Headings: Use only
H2(##) and lower for all other section headings. -
Spacing: Always place an empty line before and after all headings (except before the
H1at the very beginning of the file). -
Subdirectories: Group files into subdirectories (e.g.,
/Monsters/,/Items/) to prevent naming conflicts and organize content. -
Ingress: If an article has an ingress, it must be styled as a block quote (
>) starting with ađemoji, followed by bold text (e.g.,> đ **This is the ingress.**). -
Lists: Use a dash (
-) for Markdown lists instead of an asterisk (*) by default.
2. Wikilinks (Gollum Syntax)
-
Syntax: Use Gollum-style wikilinks:
[[Alias|Page Name#section-heading]]or[[Page Name]]. IMPORTANT: The alias always comes first and the page name comes last! -
Paths: All wikilinks pointing to a page in a subfolder (e.g.,
[[/Items/potion of healing]],[[/Artifacts/Vorpal Blade]]) must start with a slash (/), regardless of whether the source file is located in the root directory or in a subdirectory. If a link points to a page in the root directory (e.g.,[[Home]]), it should not start with a slash. -
File Extensions: Do not include the
.mdextension in wikilinks. - Case-Insensitivity: Wikilinks and file names are case-insensitive.
-
Aliases: Never use an alias in wikilinks when the link text is the same as the target page name (e.g., use
[[/Roles/Priest]]instead of[[Priest|/Roles/Priest]]). Use an alias only when the link text must differ from the page name, such as to use the plural form of the page name (e.g.,[[Priests|/Roles/Priest]]). Remember: Alias comes first, Page Name comes last. -
Dashes and Spaces: In the latest version of Gollum, dashes (
-) in Markdown filenames represent literal dashes, unlike GitHub wikis where they represent spaces. A space in a filename denotes a space (and is represented as%20in URLs). Therefore, when linking to a page with a dash in its filename, keep the dash in the wikilink; do not replace it with a space. -
Capitalization: If you must capitalize a letter in the wikilink text (for example, capitalizing the first letter to start a sentence), do it by capitalizing the letter in the filename portion of the wikilink (the part after the subdirectory, if present). For example, use
[[/Items/Potion of healing]]instead of[[Potion of healing|/Items/potion of healing]].
3. Images and Uploads
-
Upload Directory: All images must be placed under the
/uploads/directory. Match the subdirectory structure of the document (e.g., an image for/Races/Dwarf.mdgoes to/uploads/Races/Dwarf/image.webp). -
Format: Use WebP format exclusively.
- A quality setting of 85 is used by default, and almost always for larger images, such as 512x512-pixel AI-generated illustrations.
- A quality setting of 100 (lossless) is used only for small icons (32x32 or smaller) and for images with flat colors, such as Excel screenshots (for example, comparison pages may have such images). They can have a very high pixel resolution but compress to a very small file size when encoded losslessly. Even though there is no strict maximum file size for such images, their file sizes are often under 100 KB.
- If a WEBP file is larger than 100 KB, tell the user the used quality setting and ask them to suggest what to do (e.g., accept the large size, lower the encoding quality, or provide a custom WEBP file).
-
Styling for Illustrative Images (these rules apply only to illustrative images, which are usually generated with AI):
- File size should be under 100 KB.
- Transparent backgrounds (no white backgrounds).
- 12-pixel rounded corners for sharp-cornered images.
- Dimensions: Square (512x512), Horizontal (Width 512), Vertical (Height 512).
-
Link Syntax: Use standard Markdown image syntax referencing the absolute path:

4. Restrictions
-
Reserved Folders: Do not create, modify, or put anything in the
/gollum/or/.gollum/directories. These are strictly reserved for wiki software functions and website files. -
Horizontal Lines: Do not use horizontal lines (e.g.,
---or***) anywhere in the wiki. They are not needed in Markdown documents. -
Markdown Flavor: The wiki uses Gollum-style Markdown, not GitHub Flavored Markdown. It does not support GitHub-style alerts (e.g.,
> [!IMPORTANT],> [!NOTE]). Use standard Markdown blockquotes with bold text and colored unicode icons as the best alternatives:- Note:
> âšī¸ **Note:** This is a note. - Tip:
> đĄ **Tip:** This is a tip. - Important:
> đĸ **Important:** This is important. - Warning:
> â ī¸ **Warning:** This is a warning. - Caution:
> đ **Caution:** This is caution.
- Note:
5. Mathematical Formulas (KaTeX)
-
Prefer Plain Text for Simple Formulas: For simple mathematical expressions or basic requirements (e.g.,
Level >= 3orLuck >= 0), format them as plain text. Do not use KaTeX for simple expressions. - Use KaTeX Only for Complex Formulas: Use KaTeX notation only for complex mathematical formulas, fraction-based equations, or multi-variable calculations.
-
Delimiters: All KaTeX formulas must start with
$and end with$. -
Example:
- Complex formula in KaTeX:
$P = \frac{1}{10 + 2 \times G \times A}$ - Simple formula in plain text:
Luck >= 0or1 in 10
- Complex formula in KaTeX:
6. Spelling
- Archaeologist: Always prefer the spelling "Archaeologist" (with the 'a' in the middle) instead of "Archeologist". This applies to all references in the wiki and the game.
7. Game Stats Conventions
-
Strength Values: When writing or verifying strength values that exceed 18, convert the C macros correctly:
- Values using
STR18(x)(e.g.,STR18(100)) should be formatted as18/xx(e.g.,18/100). - Values using
STR19(x)(e.g.,STR19(25)) should be formatted strictly asx(e.g.,25). Do not write125or19/25.
- Values using