Skip to main content
Version: 2.8

Contributing to the Meshtastic blog

The blog shares knowledge, updates, and work from the Meshtastic community. Posts are less formal than documentation, but they follow the same writing style.

What to write about​

Write about Meshtastic: tutorials, use cases, development updates, and technical deep dives all fit.

A post must be your own original work. Content published elsewhere first can't be submitted, though you may republish your post elsewhere after it appears here. Don't duplicate an existing post unless you are updating or revising it.

Avoid self-promotion and commercial content. Promoting the sale of hardware or cases, and driving traffic to other sites, are both out of scope. Affiliate links need prior approval from the project.

Author biography​

You may link to your own work or website from your author information, either in the post front matter or in the global authors file. Acceptable links include URLs, email addresses, and social media profiles. Photos must follow the Meshtastic code of conduct.

See the Docusaurus blog authors documentation for the fields available.

Content rights​

Contributions fall under the same contributor license agreement as other Meshtastic community contributions.

Length and tone​

Write professionally and informatively. Aim for 500 to 700 words at minimum. A post approaching 3000 words is usually better condensed, or split into parts.

Authors posting more than two posts per month may be asked to space them out, so a range of voices reaches the front page.

Front matter​

Every post needs this front matter.

---
title: The title of your post
description: A concise summary, shown in previews and search results
slug: A short, descriptive, unique URL identifier
authors: The author or authors, referencing the global authors file or inline
tags: Tags that categorize the post
date: The publication date in ISO 8601 format, such as 2026-03-14T13:00
hide_table_of_contents: Whether to hide the table of contents
image: Path to the social preview image
---

The default social preview is /design/web/social-preview-1200x630.png. A custom image must include the Meshtastic logo.

Images​

Compress images to webp before committing them, using a tool such as TinyPNG or cwebp. Readers on metered connections pay for every byte.

Place post images in static/img/blog and give them concise file names.

Every image needs alt text describing what it conveys. Keep node names, real coordinates, and other people's data out of frame.

Submitting​

Write the post as an .mdx file, naming the file after its slug. A post with the slug recent-mqtt-broker-changes becomes recent-mqtt-broker-changes.mdx.

Blog posts are filed by month. Create the folder for the current month if it doesn't exist yet.

Open a pull request against meshtastic/meshtastic. Maintainers and contributors review submissions for the guidelines here, accuracy, and relevance to the community.