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:

---
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"]
---

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

Headings Hierarchy

Use a clear heading structure for optimal readability:

# Main Title (H1 - Reserved for page title)

## Major Section (H2)

### Subsection (H3)

#### Minor Detail (H4)

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

Z-Craft Example:

# 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`
^Superscript	`<sup>text</sup>`	`<sup>50 hearts max</sup>`	^{50 hearts max}
_Subscript	`<sub>text</sub>`	`<sub>Server TPS</sub>`	_{Server TPS}

Advanced Text Combinations

**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

Internal Links

Link to other Z-Craft documentation pages:

[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:

[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:

[Jump to Heart Mechanics](#heart-mechanics)
[Server Rules](/community/rules#player-conduct)

Lists and Organization

Unordered Lists

Perfect for features, requirements, and tips:

### 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:

### 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:

### 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:

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:

# Teleport to player
/tp ProGamer123 ElitePvPer

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

# Check server TPS
/tps

Configuration File Example:

# 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:

// 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:

| 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:

| 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:

> **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:

<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:

<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:

![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

<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:

<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:

<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:

<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

Be Specific to Z-Craft
- Focus on Java Edition, lifesteal mechanics, competitive PvP
- Remove all Bedrock Edition references
- Include server-specific commands and features
SEO Optimization
- Use relevant keywords in titles and descriptions
- Include “Z-Craft”, “Lifesteal”, “PvP”, “Minecraft Java”
- Write compelling meta descriptions
Accessibility
- Use descriptive alt text for images
- Ensure sufficient color contrast
- Write clear, concise instructions
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 for writing guidelines. 📚

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

​Markdown Guide for Z-Craft Documentation ✍️

​Document Structure

​Frontmatter Headers

​Headings Hierarchy

​Text Formatting

​Basic Formatting

​Advanced Text Combinations

​Links and Navigation

​Internal Links

​External Links

​Anchor Links

​Lists and Organization

​Unordered Lists

​Ordered Lists

​Task Lists

​Code Blocks and Technical Content

​Inline Code

​Code Blocks

​Syntax Highlighting

​Tables and Data Presentation

​Basic Tables

​Advanced Tables

​Blockquotes and Callouts

​Standard Blockquotes

​Mintlify Callout Components

​Step-by-Step Instructions

​Images and Media

​Image Embedding

​Image with Captions

​Cards and Interactive Elements

​Card Groups

​Accordions

​Mathematical Content

​LaTeX Equations

​Best Practices for Z-Craft Documentation

​Content Standards

​Quality Checklist

Markdown Guide for Z-Craft Documentation ✍️

Document Structure

Frontmatter Headers

Headings Hierarchy

Text Formatting

Basic Formatting

Advanced Text Combinations

Links and Navigation

Internal Links

External Links

Anchor Links

Lists and Organization

Unordered Lists

Ordered Lists

Task Lists

Code Blocks and Technical Content

Inline Code

Code Blocks

Syntax Highlighting

Tables and Data Presentation

Basic Tables

Advanced Tables

Blockquotes and Callouts

Standard Blockquotes

Mintlify Callout Components

Step-by-Step Instructions

Images and Media

Image Embedding

Image with Captions

Cards and Interactive Elements

Card Groups

Accordions

Mathematical Content

LaTeX Equations

Best Practices for Z-Craft Documentation

Content Standards

Quality Checklist