contribute
5 min read
Documentation Editors
Feature showcase and guide for documentation editors
Feature showcase and guide for documentation editors
This guide showcases all available formatting options and components for our documentation. Use this as a reference when writing new docs.
This is a Callout component. It's useful for highlighting important information.
We support standard markdown formatting:
PRO TIP: Blockquotes are great for calling out specific advice or quotes. They are styled with a left border.
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 |
Use different types of callouts to communicate context.
General information that doesn't fit into the main flow.
Helpful advice to improve the user experience.
Be careful! This action might have consequences.
This is a critical alert. Data loss is possible.
Operation completed successfully!
This information is crucial for understanding the topic.
This demonstrates how to use a feature.
Use badges to display status, labels, or categories.
Default Available Beta Deprecated New Optional Small Default LargeUse Cards to link to other sections visually.
Use Steps for tutorials or guides.
Download the latest JAR file and place it in your plugins folder.
cp eternalcore.jar /path/to/server/plugins/
Restart your Minecraft server to generate the configuration files.
Edit config.yml to suit your needs.
Organize code examples by language or platform.
public class Example {
public static void main(String[] args) {
System.out.println("Hello World!");
}
}
Display CLI commands with copy functionality.
npm install eternalcore./gradlew buildmvn clean installcurl -fsSL https://example.com/install.sh | bashCompare code implementations with an interactive slider. Drag the line or use arrow keys to reveal before/after code side-by-side.
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();
}
}
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);
}
}
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",
};
Display project structure or file hierarchies.
Create rich link previews for external resources or related documentation.
Learn about EternalCore, a lightweight Minecraft plugin with essential features.
View the source code, report issues, and contribute to the project.
Use dividers to separate content sections.
| Component | Status | Version |
|---|---|---|
| EternalCore | Stable | 2.0.0 |
| EternalCombat | Beta | 1.5.0 |
| Multification | New | 1.0.0 |
All components are built with accessibility in mind:
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.