Skip to content
beakscraft

← Back to all guides

Tips

Write a guide or post

2026-06-01

By Beakscraft

writingcontributingmeta

If you know something useful about the server — how a faction mechanic works, what to expect from a new event, the best way to set up a chest shop — the rest of us would like to read it.

You can contribute two kinds of content:

  • Guides are evergreen how-tos. "How shops work", "Install SVC", "First hour on the server". They live on /guides.
  • News posts are timely updates. Spawn reworks, event recaps, plugin announcements, the occasional ramble. They live on /news.

The flow below is the same for both — only the frontmatter and the destination folder differ.


1. Open the previewer

Open the previewer →

The previewer is a side-by-side editor. You paste and write markdown on the left, it renders on the right exactly the way it'll look once published. Your work is saved in your browser as you type — but we still suggest keeping your own backup so nothing gets lost.

At the top of the previewer there's a Guide / News post toggle. Flip it to whichever you're writing — the example, the suggested filename, and the side-panel preview all change to match.


2. Add the frontmatter

Every guide and post starts with a small block at the top called "frontmatter" — the metadata that tells the site how to file your content.

For a guide:

---
title: Your guide title
date: 2026-06-01
section: Getting started
tags: [beginner, spawn]
author: YourMinecraftName
summary: One-line tease shown on the guides index.
---

For a news post:

---
title: Your post title
date: 2026-06-01
author: BeaksOwner
summary: One-line tease shown on the news index.
---

The shared fields:

  • title — what shows up at the top of the page and in the list. Keep it short. For guides, verb-led works well: "Create a faction", "Install SVC". For posts, descriptive: "Spawn rework is live", "March event recap".

  • dateYYYY-MM-DD. Used for sort order.

  • author (optional) — your Minecraft username for the byline. Omit the line if you don't want one.

    Server staff are welcome to author their post as 'Beakscraft' if they wish to do so.

  • summary — one sentence that shows on the index card. Make it specific. "How shops work" tells me nothing — "How to set up a chest shop with the right sign syntax" tells me exactly what's inside.

  • hidden (optional) — add hidden: true to keep the entry out of production. Useful for drafts in progress, or for content tied to a future event you don't want to spoil yet.

Guide-specific fields:

  • section — the major bucket your guide belongs in. Current sections: Getting started, Economy, Factions, Worlds, PvP, Commands, Mods, Tips. Reuse one where it fits. A new section name will work (it'll appear in the filter automatically) but check with the team before inventing one.
  • tags — a comma-separated list inside square brackets. Tags are free-form; reuse existing ones where they fit and only invent new ones if nothing fits.

3. Write the body

After the second --- line, write in plain markdown. See the basics below ↧ for the syntax.


4. Add images (optional)

If your guide or post needs screenshots, take them in-game (press F2 in vanilla Minecraft to save a clean shot to .minecraft/screenshots/) and attach them alongside your markdown file when you submit to the 🦈〃「content」 forum on Discord (see step 6). A staff member will save them to the site and wire up the paths.

A few practical things to know:

  • Name them in display order. If you have several images, prefix the filenames 01-spawn.png, 02-bridge.png, 03-interior.png, etc. They'll appear in that order on the page.

  • Reference them in your markdown like this, leaving <slug> as a placeholder — staff will fill in the real slug when they save it:

    ![Signs at spawn](/assets/guides/<slug>/01-spawn.png)
    

    For news posts, swap guides for posts:

    ![New spawn layout](/assets/posts/<slug>/01-after.png)
    
  • The previewer won't show your real images (they're not uploaded yet), but it'll display a broken-image placeholder so you can confirm the markdown syntax is right. The image will appear once staff publishes the guide / post.

If you're unsure where an image fits in your draft, just describe where in a Discord message — staff can place it.


5. Tips for content that gets used

  • One thing per piece. "How to set up a chest shop" is one guide. "How shops, the economy, prices, and the market work" is four. Same for posts — we try to keep it to one update per post.
  • Lead with the answer. Tell the reader what they'll get from this page in the first paragraph. Don't make them read three "but first…" sections.
  • Show, don't tell. If there's a command, show the actual command in a code block. If there's a screenshot worth attaching, attach it (see step 4).
  • Hide unreleased stuff. Use hidden: true in the frontmatter for content tied to a future event or plugin you don't want to spoil yet. Let us know when you submit so we can flip it on at the right time.

6. Get it on the site

Once the preview looks right:

  1. Copy or download the markdown with the Copy or download button on the previewer.
  2. Send it to the 🦈〃「content」 forum on Discord with a suggested filename (lowercase-hyphenated, e.g. set-up-a-chest-shop for a guide, spawn-rework-is-live for a post).
  3. If you have images, attach them in the same post or follow up in the thread.

A staff member saves it as:

  • Guide: src/guides/<your-guide-title>/guide.md (plus any images in the same folder)
  • Post: src/posts/<your-post-title>/post.md (plus any images in the same folder)

We'll get posts uploaded as soon as possible.


That's the whole flow.


The markdown basics

Each section below shows the syntax in a code block, followed by how it actually renders on the page.


Headings

Use ## for section headings and ### for sub-sections inside them. (# is reserved for the page title, which the frontmatter sets — don't use it in the body.)

A section heading

A sub-heading


Bold, italic, inline code

**bold**bold *italic*italic /sell hand/sell hand


Lists

Source:

- First item
- Second item
- Third item

1. Numbered also works
2. So does this

Renders as:

  • First item
  • Second item
  • Third item
  1. Numbered also works
  2. So does this

Links

External links use the standard syntax: [text](https://example.com).

please avoid linking to multiple external sources, we can't verify every website is safe, and are unlikely to be owned by us

Internal links use absolute paths starting with / — never relative paths like ../news. For example [/builds](/builds)/builds, and [How shops work](/guides/how-shops-work)How shops work.


Images

Same shape as links, prefixed with !:

![Alt text describing the image](/assets/guides/your-slug/01-image.png)

See step 4 above for where to put the image file.


Code blocks

For multi-line code or command sequences, wrap in triple backticks:

```
/f create northhold
/f invite some-friend
/f sethome
```

Renders as:

/f create northhold
/f invite some-friend
/f sethome

Blockquotes

Prefix a paragraph with >:

> Useful for callouts, warnings, or quoting another player.

Renders as:

Useful for callouts, warnings, or quoting another player.

← Back to all guides