> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.z-craft.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Markdown Guide for Z-Craft Documentation

> Complete markdown syntax guide with Z-Craft specific examples for writing server documentation, guides, and community content

# Markdown Guide for Z-Craft Documentation ✍️

Master the art of writing clear, professional documentation for Z-Craft's community wiki. This comprehensive guide covers essential markdown syntax with practical examples tailored for Minecraft server documentation, lifesteal mechanics, and community content.

## Document Structure

### Frontmatter Headers

Every Z-Craft documentation file starts with YAML frontmatter:

```yaml theme={null}
---
title: "Complete Guide to Lifesteal PvP"
description: "Master the art of heart-stealing combat on Z-Craft's competitive Minecraft server"
keywords: ["Lifesteal PvP guide", "heart stealing mechanics", "Z-Craft combat", "Minecraft PvP strategies"]
---
```

<Info>
  **Z-Craft Frontmatter Standards:**

  * `title`: Descriptive and SEO-friendly (50-60 characters)
  * `description`: Compelling summary (150-160 characters)
  * `keywords`: 3-5 relevant terms for search optimization
</Info>

### Headings Hierarchy

Use a clear heading structure for optimal readability:

```md theme={null}
# Main Title (H1 - Reserved for page title)

## Major Section (H2)

### Subsection (H3)

#### Minor Detail (H4)

##### Implementation Note (H5 - Use sparingly)
```

**Z-Craft Example:**

```md theme={null}
# Lifesteal PvP Combat Guide

## Heart Mechanics
### Stealing Hearts
### Maximum Hearts
### Death Consequences

## Combat Strategies
### PvP Arena Tactics
### Base Defense
### Team Coordination
```

## Text Formatting

### Basic Formatting

| Style                  | Syntax            | Z-Craft Example            | Result                   |
| ---------------------- | ----------------- | -------------------------- | ------------------------ |
| **Bold**               | `**text**`        | `**Lifesteal** mechanics`  | **Lifesteal** mechanics  |
| *Italic*               | `*text*`          | `*Premium* ranks`          | *Premium* ranks          |
| ~~Strikethrough~~      | `~~text~~`        | `~~Bedrock Edition~~`      | ~~Bedrock Edition~~      |
| `Inline Code`          | `` `text` ``      | `` `hearts` ``             | `hearts`                 |
| <sup>Superscript</sup> | `<sup>text</sup>` | `<sup>50 hearts max</sup>` | <sup>50 hearts max</sup> |
| <sub>Subscript</sub>   | `<sub>text</sub>` | `<sub>Server TPS</sub>`    | <sub>Server TPS</sub>    |

### Advanced Text Combinations

```md theme={null}
**Bold and *italic* text** with `inline code` examples.

~~Outdated information~~ → **Updated for Java Edition only**
```

**Result:**
**Bold and *italic* text** with `inline code` examples.

~~Outdated information~~ → **Updated for Java Edition only**

## Links and Navigation

### Internal Links

Link to other Z-Craft documentation pages:

```md theme={null}
[Joining Z-Craft servers](/getting-started/joining-servers)
[Admin commands reference](/staff/admin-commands)
[Report violations](/community/reporting-appeals)
```

### External Links

Link to external resources with security indicators:

```md theme={null}
[Official Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-edition) 🔗
[Z-Craft Discord Server](https://discord.gg/z-craft) 💬
```

### Anchor Links

Link to specific sections within pages:

```md theme={null}
[Jump to Heart Mechanics](#heart-mechanics)
[Server Rules](/community/rules#player-conduct)
```

## Lists and Organization

### Unordered Lists

Perfect for features, requirements, and tips:

```md theme={null}
### Lifesteal Server Features
- **Heart-stealing combat** - Lose hearts when defeated
- **Rank progression** - Climb from Default to Legend
- **Economy system** - Buy/sell items and services
- **Custom plugins** - Enhanced gameplay mechanics
- **24/7 uptime** - Reliable server availability
```

### Ordered Lists

Essential for step-by-step instructions:

```md theme={null}
### Getting Started with Z-Craft

1. **Download Minecraft Java Edition**
   - Purchase from [official website](https://minecraft.net)
   - Ensure version 1.20.4 or later

2. **Join our Discord server**
   - Connect at [discord.gg/z-craft](https://discord.gg/z-craft)
   - Verify your account in #verification

3. **Launch Minecraft and add server**
   - Open Minecraft Launcher
   - Navigate to Multiplayer → Add Server
   - Enter: `play.z-craft.xyz`

4. **Start your adventure**
   - Select server and click Join
   - Complete tutorial in spawn area
   - Begin collecting hearts!
```

### Task Lists

Track progress and requirements:

```md theme={null}
### Server Staff Requirements
- [x] Must be 16+ years old
- [x] Active Discord member (30+ days)
- [x] 500+ hours playtime on Z-Craft
- [ ] Completed staff training course
- [ ] Passed background check
```

## Code Blocks and Technical Content

### Inline Code

Use for commands, file names, and technical terms:

```md theme={null}
Execute `/spawn` to return to the main hub.
Edit `server.properties` for configuration changes.
The `lifesteal` plugin handles heart mechanics.
```

### Code Blocks

Essential for commands, configurations, and scripts:

**Server Command Examples:**

```bash theme={null}
# Teleport to player
/tp ProGamer123 ElitePvPer

# Give player hearts (admin only)
/hearts give ProGamer123 5

# Check server TPS
/tps
```

**Configuration File Example:**

```yaml theme={null}
# plugins/LifestealCore/config.yml
heart-stealing:
  enabled: true
  max-hearts: 50
  min-hearts: 1
  death-penalty: 1

rank-system:
  enabled: true
  ranks:
    - name: "Default"
      hearts-required: 0
    - name: "VIP"
      hearts-required: 25
    - name: "Premium"
      hearts-required: 40
    - name: "Elite"
      hearts-required: 50
```

**Java Code Example:**

```java theme={null}
// Example plugin code for Z-Craft
public class HeartStealListener implements Listener {

    @EventHandler
    public void onPlayerDeath(PlayerDeathEvent event) {
        Player victim = event.getEntity();
        Player killer = victim.getKiller();

        if (killer != null) {
            // Steal one heart from victim
            stealHeart(victim, killer);
            killer.sendMessage("§aYou stole a heart from " + victim.getName() + "!");
        }
    }
}
```

### Syntax Highlighting

Supported languages for code blocks:

* `java` - Java plugins and code
* `yaml` - Configuration files
* `bash` - Server commands and scripts
* `json` - API responses and data
* `sql` - Database queries
* `markdown` - Documentation examples

## Tables and Data Presentation

### Basic Tables

Display structured information clearly:

```md theme={null}
| Rank | Hearts Required | Benefits |
|------|----------------|----------|
| Default | 0 | Basic access |
| VIP | 25 | Colored name, /hat command |
| Premium | 40 | Priority queue, custom pets |
| Elite | 50 | All perks, exclusive events |
| Legend | 50+ | Hall of fame, special title |
```

### Advanced Tables

Include formatting and links:

```md theme={null}
| Command | Permission | Description | Example |
|---------|------------|-------------|---------|
| `/hearts` | All players | Check heart count | `/hearts` |
| `/pay` | All players | Transfer money | `/pay ProGamer123 1000` |
| `/tpa` | VIP+ | Teleport request | `/tpa ElitePvPer` |
| `/ban` | Staff only | Ban player | `/ban TrollPlayer griefing` |
```

## Blockquotes and Callouts

### Standard Blockquotes

Highlight important information:

```md theme={null}
> **Server Rule #1:** No griefing allowed. Players caught griefing will be permanently banned.
>
> **Heart Safety Tip:** Always keep backup hearts in your ender chest. Losing all hearts means permadeath!
```

### Mintlify Callout Components

Use specialized callout components for better visual hierarchy:

```md theme={null}
<Info>
**Java Edition Only:** Z-Craft exclusively supports Minecraft Java Edition for optimal performance and competitive integrity.
</Info>

<Warning>
**Lifesteal Risk:** Death in PvP combat results in permanent heart loss. Prepare accordingly!
</Warning>

<Tip>
**Pro Strategy:** Use potions and enchantments to maximize your heart-stealing potential in arena combat.
</Tip>

<Note>
**Staff Note:** Administrative commands should only be used when necessary. All actions are logged for review.
</Note>
```

### Step-by-Step Instructions

Use the Steps component for complex procedures:

```md theme={null}
<Steps>
1. **Access the admin panel**
   - Log into the staff dashboard
   - Navigate to Player Management

2. **Locate the player**
   - Search by username or UUID
   - Review their violation history

3. **Apply appropriate action**
   - Choose warning, mute, or ban
   - Add detailed reason for audit trail

4. **Document the incident**
   - Log details in the moderation database
   - Notify other staff if needed
</Steps>
```

## Images and Media

### Image Embedding

Include screenshots and diagrams:

```md theme={null}
![Z-Craft Spawn Area](images/spawn-area.png)
*Figure 1: The main spawn area with heart shop and PvP arena entrance*

![Heart Stealing Mechanics](images/heart-mechanics-diagram.png)
*Figure 2: Visual representation of lifesteal heart transfer*
```

### Image with Captions

```md theme={null}
<Figure caption="Z-Craft's competitive PvP arena with custom heart-stealing mechanics">
  ![PvP Arena](images/pvp-arena.png)
</Figure>
```

## Cards and Interactive Elements

### Card Groups

Organize related content:

```md theme={null}
<CardGroup>
  <Card
    title="Getting Started"
    icon="rocket"
    href="/getting-started/account-setup"
  >
    New to Z-Craft? Learn how to join our Java Edition lifesteal server.
  </Card>
  <Card
    title="Combat Guide"
    icon="sword"
    href="/gameplay/lifesteal-guide"
  >
    Master heart-stealing mechanics and PvP strategies.
  </Card>
  <Card
    title="Server Rules"
    icon="shield"
    href="/community/rules"
  >
    Understand our community guidelines and conduct expectations.
  </Card>
</CardGroup>
```

### Accordions

Condense detailed information:

```md theme={null}
<Accordion title="Advanced PvP Strategies">
  ### Positioning
  Control high ground and chokepoints to limit enemy movement.

  ### Resource Management
  Conserve potions and tools. One death can be devastating.

  ### Team Coordination
  Communicate constantly. Coordinate flanks and support.
</Accordion>
```

## Mathematical Content

### LaTeX Equations

For advanced calculations and formulas:

```md theme={null}
<Latex>
\text{Heart Transfer Rate} = \frac{\text{Victim Hearts} \times \text{Steal Multiplier}}{100}
</Latex>

<Latex>
\text{Server TPS} = \frac{20000}{\text{Actual MSPT}}
</Latex>
```

## Best Practices for Z-Craft Documentation

### Content Standards

1. **Be Specific to Z-Craft**
   * Focus on Java Edition, lifesteal mechanics, competitive PvP
   * Remove all Bedrock Edition references
   * Include server-specific commands and features

2. **SEO Optimization**
   * Use relevant keywords in titles and descriptions
   * Include "Z-Craft", "Lifesteal", "PvP", "Minecraft Java"
   * Write compelling meta descriptions

3. **Accessibility**
   * Use descriptive alt text for images
   * Ensure sufficient color contrast
   * Write clear, concise instructions

4. **Consistency**
   * Follow established heading hierarchy
   * Use consistent terminology
   * Maintain professional tone

### Quality Checklist

* [ ] Frontmatter includes title, description, and keywords
* [ ] Content is Java Edition focused
* [ ] Links are functional and properly formatted
* [ ] Code examples are accurate and tested
* [ ] Images have alt text and captions
* [ ] Tables are properly formatted
* [ ] Callouts used appropriately
* [ ] Content is free of spelling/grammar errors

***

**Ready to contribute?** Start writing your first Z-Craft documentation page or [contact staff](/support/modmail) for writing guidelines. 📚

***

*Documentation Style Guide v2.1 | Last updated: December 2024*