Skip to main 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:
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:
Z-Craft Example:

Text Formatting

Basic Formatting

Advanced Text Combinations

Result: Bold and italic text with inline code examples. Outdated informationUpdated for Java Edition only Link to other Z-Craft documentation pages:
Link to external resources with security indicators:
Link to specific sections within pages:

Lists and Organization

Unordered Lists

Perfect for features, requirements, and tips:

Ordered Lists

Essential for step-by-step instructions:

Task Lists

Track progress and requirements:

Code Blocks and Technical Content

Inline Code

Use for commands, file names, and technical terms:

Code Blocks

Essential for commands, configurations, and scripts: Server Command Examples:
Configuration File Example:
Java Code Example:

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:

Advanced Tables

Include formatting and links:

Blockquotes and Callouts

Standard Blockquotes

Highlight important information:

Mintlify Callout Components

Use specialized callout components for better visual hierarchy:

Step-by-Step Instructions

Use the Steps component for complex procedures:

Images and Media

Image Embedding

Include screenshots and diagrams:

Image with Captions

Cards and Interactive Elements

Card Groups

Organize related content:

Accordions

Condense detailed information:

Mathematical Content

LaTeX Equations

For advanced calculations and formulas:

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 for writing guidelines. 📚
Documentation Style Guide v2.1 | Last updated: December 2024