📚 Markdown Writing Guide for The White Archive Wiki

Welcome to the Markdown Writing Guide for The White Archive Wiki! This guide will help you write clean, well-organized pages in Markdown, making it easy for users to read and navigate content.

Editors note: I'm not this into firearms I swear, I think the AI was just uncomfortable saying politically incorrect things. So calm it down glowies.

✅ Quick Markdown Reference

🖋️ Markdown Basics for Wiki Pages

Markdown is a lightweight language used to convert plain text into structured HTML. It’s simple to learn and helps ensure consistency across all Wiki pages.

🔤 1. Headers (Titles and Subtitles)

Headers are used to organize content into sections and subsections. The more # symbols you use, the smaller the header.

Example:

📋 2. Lists (Bullet Points and Numbered Lists)

Use lists to organize ideas or break down content into digestible points.

🔹 Bullet Points

Use - or * to create bullet points.

Output:

• First Bullet Point
• Second Bullet Point
  • Sub-bullet Point

🔢 Numbered Lists

To create ordered lists, simply use numbers followed by a period.

Output:

1. First item
2. Second item
   1. Sub-item

🔗 3. Links (Internal and External)

Use the following format to link to other pages within the wiki. Make sure to include the / at the start of the page path.

Black Crime

Note in the example above a couple things. If the text you wrap in brackets matches a page name it will automatically fill out the rest once you put in the: (/

The page title wrapped in brackets can be anything you want, it doesn't have to match the page name or path. For Example:

Will still output a link to the page black crime, but the link itself will display what you wrap in brackets.

this can say anything

The path IS case sensitive, and must begin with / for you to use only the page directory. If you dont put the / you would have to include a full link.

Outputs full link example

🌐 External Links (Websites)

For external links, use the standard Markdown format:

🖼 4. Images

Embedding Images

Embed images in your pages using markdown

For clickable images that open larger versions in a new page:

<a href="/imagename.jpg">
    <img src="/imagenamethumb.jpg" alt="Image 1">
</a>

renders as

when you replace the imagename with the uploaded file name. Note for this to work you must upload 2 images, one for the thumbnail one for the bigger image.

This way is easier to remember but you can do either in markdown.  [](https://www.thewhitearchive.org/categories.jpg))

This renders as

![[categories

If you're having trouble with it showing up, the important part is the ] then just put the larger image next to it (fulllinkagain)

To ensure images meet quality and usability standards, test resizing and clarity before uploading. Suggested tools include:

• ReduceImages for single-image resizing.
• image magick for batch images. I've even put together scripts that you can save which will take all the images from one folder, resize and rename them, and output them in 2 separate folders

For Wiki.js, upload images to the Assets Manager and use their paths directly.

💬 5. Blockquotes

Blockquotes are used to highlight important information, quotes, or warnings.

Output:

This is a note or warning.

📊 6. Tables

Tables are helpful for organizing facts, events, or comparisons.

Output:

🧱 7. Code Blocks

Code blocks are useful for commands, scripts, or technical information.

Inline Code:

Use backticks   ` for inline code.

Output:
The command ls -la lists all files in a directory.

Code Blocks:

Use triple backticks (```) to create a code block.

 docker ps -a

See the page on coding

📋 9. Task Lists

Task lists help track progress on tasks or projects.

Output:

• [ ] Research historical firearm development
• [x] Add images to the timeline
• [ ] Link related Wiki pages

🎨 10. Formatting Text (Bold, Italic, Highlight)

🧩 11. Embedding Notes (For Internal Links)

To embed the content of another Wiki page, use:

🧪 Example Page Structure

Here's an example of a complete page using the elements we've covered:

Related Pages

• coding
• advanced formatting

🎯 Next Steps for Contributors:

1. Start writing your pages using this guide.
2. Link related pages for better navigation.
3. Use images and tables to enhance your content.
4. Tag your pages for better searchability.

This guide will ensure your pages are consistently formatted and easy to read.