> For the complete documentation index, see [llms.txt](https://esmp-fun.gitbook.io/plugins/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://esmp-fun.gitbook.io/plugins/markdown-guide/markdownguide.md).

# MarkdownGuide

An in-game guide for your Minecraft server, written like a document.

You write your pages as plain text files, the way you would write a note. Players open them with `/guide`, and every page is drawn to the pixel: a page list down the left, headings, tables, coloured boxes, item icons and buttons. You can edit the pages in game, in a text editor, or in a browser that shows you exactly what players will see as you type.

<figure><img src="https://1037515809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F37kaU8TF94yOlMmCwXdl%2Fuploads%2Fgit-blob-63716eccbc8ab145bfdd7972a1adba0ec559c727%2Fguide-welcome.png?alt=media" alt="A guide page in game, with the list of pages on the left"><figcaption><p>A guide page in game.</p></figcaption></figure>

## Which applies to you?

* **I just installed it.** Start with [Install it](/plugins/markdown-guide/getting-started/installation.md). There is one setting every real server needs, and it takes a minute.
* **I want to write pages.** [Your first page](/plugins/markdown-guide/getting-started/your-first-page.md) shows the whole loop, and [Edit in your browser](/plugins/markdown-guide/getting-started/the-web-editor.md) is the easiest way to do it.
* **I want it to look like my server.** See [style.css](/plugins/markdown-guide/look-and-layout/style.md) and [The sidebar](/plugins/markdown-guide/look-and-layout/sidebar.md).

## What a page can hold

|             |                                                                             |
| ----------- | --------------------------------------------------------------------------- |
| Text        | Headings, **bold**, *italic*, lists, quotes, and any of Minecraft's colours |
| Pictures    | Any item or block from the game, and pictures of your own                   |
| Boxes       | Note, tip, important, warning and caution boxes                             |
| Tables      | Columns that line up exactly                                                |
| Links       | To another page, a website, or a command                                    |
| Buttons     | Open a page or run a command with one click                                 |
| Each player | Their name, the players online, parts only some players see                 |
| Settings    | Another plugin's settings, changed right from the page                      |

## Will it work on my server?

|                   |                                            |
| ----------------- | ------------------------------------------ |
| Server software   | **Paper**, or a fork of it like **Purpur** |
| Minecraft version | **26.3** or newer                          |
| Java              | **25** or newer, which 26.3 already needs  |

{% hint style="warning" %}
**It will not work on 26.2 or older.** Pages are lined up to the pixel, and how the game lays out text changed in 26.3.

**Players need the guide's resource pack.** The plugin makes it and offers it when they join, so nobody installs anything by hand. A player who turns server resource packs off is told how to turn them back on when they open the guide.
{% endhint %}

## Where to go next

* [Install it](/plugins/markdown-guide/getting-started/installation.md), then [write your first page](/plugins/markdown-guide/getting-started/your-first-page.md).
* [Edit in your browser](/plugins/markdown-guide/getting-started/the-web-editor.md), with a live preview.
* Every command, permission and setting is listed under **Reference**.
* Something not working? [Troubleshooting](/plugins/markdown-guide/help/troubleshooting.md) has the fix.