Redigera sidor¶

Den här sidan beskriver hur innehåll på Meshat.se bör skrivas för att vara enkelt att förstå, enkelt att underhålla och logiskt för läsaren.

Håll det enkelt¶

Utgångspunkten för hela sajten är att innehållet ska vara lätt att läsa och lätt att uppdatera.

• varje sida bör ha samma grundstruktur
• länkar bör peka direkt till markdown-sidor eller externa tjänster
• innehållet bör vara enkelt att förstå och ändra
• varje sida bör fokusera på ett tydligt ämne

Grundprinciper¶

• skriv i ren Markdown
• använd vanliga relativa länkar till andra .md-sidor
• håll varje sida fokuserad på ett ämne
• välj den enklaste lösningen som fungerar

Rekommenderad sidstruktur¶

Använd helst samma grundstruktur på alla informationssidor:

1. kort introduktion
2. huvudavsnitt i logisk ordning
3. praktiska exempel eller kodblock
4. avsnittet Nästa steg eller Vidare läsning

Det här gör att sidorna känns igen oavsett om de handlar om Meshtastic, MeshCore eller MQTT.

Front matter¶

Alla nya sidor bör ha enkel front matter:

---
title: Sidans titel
icon: lucide/file-text
description: Kort beskrivning av sidan.
---

Länkar¶

Internt¶

Använd relativa länkar, till exempel:

[Anslut till MQTT-servern](../mqtt/connect-to-mqtt.md)

Externt¶

Använd fullständig URL för externa resurser.

Om du länkar till en sida på sajten, peka på själva .md-filen i källan. Då blir navigationen tydlig och konsekvent.

Innehållsstil¶

• skriv korta stycken
• använd rubriker i stället för långa textblock
• använd tabeller för inställningar och jämförelser
• använd !!! note, !!! tip och !!! warning sparsamt när det tillför tydlighet
• skriv hellre konkret än formellt
• börja med det viktigaste för läsaren

Undvik¶

• otydliga länkar som pekar på kataloger i stället för sidor
• blandning av olika strukturmönster mellan sidor
• långa inledningar som inte hjälper läsaren vidare
• information som inte hjälper läsaren vidare i ämnet

Checklista före publicering¶

• fungerar rubrikerna i logisk ordning?
• har sidan titel, ikon och beskrivning?
• fungerar alla interna länkar?
• finns ett tydligt nästa steg för läsaren?
• känns sidan enkel att läsa och enkel att uppdatera?