Documentation Editors Guide

This guide showcases all available formatting options and components for our documentation. Use this as a reference when writing new docs.

Information

This is a Callout component. It's useful for highlighting important information.

Basic Formatting

Text Styles

We support standard markdown formatting:

Bold text for emphasis
Italic text for subtle emphasis
Inline code for technical terms
~~Strikethrough~~ for deprecated content

Blockquotes

PRO TIP: Blockquotes are great for calling out specific advice or quotes. They are styled with a left border.

Tables

Tables are automatically styled and responsive.

Feature	Status	Description
MDX	Supported	Native react components in markdown
Tables	Supported	Auto-formatted tables
Code	Supported	Syntax highlighting & copy

Special Components

Callouts

Use different types of callouts to communicate context.

Note

General information that doesn't fit into the main flow.

Pro Tip

Helpful advice to improve the user experience.

Warning

Be careful! This action might have consequences.

Critical

This is a critical alert. Data loss is possible.

Success

Operation completed successfully!

Important

This information is crucial for understanding the topic.

Example

This demonstrates how to use a feature.

Badges

Use badges to display status, labels, or categories.

Default Available Beta Deprecated New Optional Small Default Large

Cards

Use Cards to link to other sections visually.

Quick Start

Configuration

API Reference

Steps

Use Steps for tutorials or guides.

Install the Plugin

Download the latest JAR file and place it in your plugins folder.

cp eternalcore.jar /path/to/server/plugins/

Restart Server

Restart your Minecraft server to generate the configuration files.

Configure

Edit config.yml to suit your needs.

Code Tabs

Organize code examples by language or platform.

public class Example {
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

Commands

Display CLI commands with copy functionality.

npm install eternalcore

./gradlew build

mvn clean install

curl -fsSL https://example.com/install.sh | bash

Before & After Comparison

Compare code implementations with an interactive slider. Drag the line or use arrow keys to reveal before/after code side-by-side.

With Library

Clean

public class MessageSender {
    private final NoticeService noticeService;
    
    public void sendMessage(Player player, String message) {
        // Simple, clean API
        noticeService.create()
            .notice(message)
            .player(player.getUniqueId())
            .send();
    }
}

Without Library

Verbose

public class MessageSender {
    public void sendMessage(Player player, String message) {
        // Manual color code translation
        String formatted = message
            .replace("&0", "§0")
            .replace("&1", "§1")
            .replace("&2", "§2")
            .replace("&3", "§3")
            .replace("&4", "§4")
            .replace("&5", "§5")
            .replace("&6", "§6")
            .replace("&7", "§7")
            .replace("&8", "§8")
            .replace("&9", "§9")
            .replace("&a", "§a")
            .replace("&b", "§b")
            .replace("&c", "§c")
            .replace("&d", "§d")
            .replace("&e", "§e")
            .replace("&f", "§f");
        
        player.sendMessage(formatted);
    }
}

Drag to compare or use arrow keys to adjust

Component Features

Interactive Slider: Drag the vertical line to compare code
Keyboard Navigation: Use arrow keys, Home, and End keys
Smooth Dragging: Fluid experience with no text selection
Touch Support: Works on mobile devices
Custom Labels: Add badges like "Verbose" or "Clean" in headers

Code Blocks

Code blocks feature syntax highlighting and a copy button that appears on hover!

// Example TypeScript code
interface User {
  id: number;
  name: string;
}

const user: User = {
  id: 1,
  name: "EternalCode",
};

File Tree

Display project structure or file hierarchies.

Link Previews

Create rich link previews for external resources or related documentation.

EternalCore Introduction

Learn about EternalCore, a lightweight Minecraft plugin with essential features.

EternalCore on GitHub

View the source code, report issues, and contribute to the project.

Dividers

Use dividers to separate content sections.

Component Usage Examples

Using Badges in Tables

Component	Status	Version
EternalCore	Stable	2.0.0
EternalCombat	Beta	1.5.0
Multification	New	1.0.0

Best Practices

Use Callouts for important information that needs to stand out
Use Steps for sequential instructions or tutorials
Use Badges for status indicators and labels
Use Commands for CLI instructions that users need to copy
Use File Trees to show project structure or file locations
Use Link Previews for important external or internal links
Use Code Tabs to organize code examples by language or platform

Accessibility

All components are built with accessibility in mind:

Keyboard navigation support
ARIA labels and roles
Screen reader compatibility
Respects prefers-reduced-motion settings
Focus management
Semantic HTML

Need Help?

If you have questions about using these components or need to add new ones, please reach out to the documentation team or open an issue on GitHub.