## Utvecklararbetsflöde
Förhandsgranska GitHub README.md lokalt på Mac
Publicerad mars 2026
Du redigerade README. Nu vill du se hur det ser ut innan du pushar. Här är tre sätt att göra det, från tungviktare till blixtsnabbt.
## Varför förhandsgranska lokalt
Varför förhandsgranska lokalt?
- Kontrollera formateringen innan push. Trasiga tabeller, felaktiga länkar och förstörda kodblock är pinsamma i ett offentligt repo. Fånga dem innan
git push. - Arbeta offline. Flygplan, tåg, kafféer med dålig wifi. Din README borde inte behöva internetanslutning för att granskas.
- Granska dokumentationsändringar i PR. När en pull request uppdaterar README vill du se det renderade resultatet bredvid koddiffet.
- Undvik commit-push-kolla-cykeln. Att pusha en commit bara för att se hur README renderas på GitHub förorenar din git-historik och slösar tid.
## Metod 1
grip (CLI-verktyg)
pip install grip grip README.md
grip renderar ditt Markdown med GitHub API, så du får pixelperfekt GitHub-rendering i webbläsaren på localhost:6419.
Fördelar
- Exakt GitHub-rendering (använder deras API)
Nackdelar
- Kräver Python installerat
- Behöver en GitHub API-token vid hög användning (annars hastighetsbegränsad)
- Kör en lokal server som du måste starta och stoppa
- Inte offline-vänligt (anropar GitHub API)
## Metod 2
VS Code inbyggd förhandsgranskning
Öppna README.md i VS Code Cmd + Shift + V → förhandsgranskningspanel
VS Code har en inbyggd Markdown-förhandsgranskning. Öppna filen, tryck kortkommandot och en sidopanel visar det renderade resultatet.
Fördelar
- Redan installerat för de flesta utvecklare
- Fungerar offline
Nackdelar
- Att starta en hel IDE för att förhandsgranska en README är överdrivet
- Renderingen matchar inte GitHub exakt (inget callout-stöd, annan tabellstil)
- Bunden till din editor — kan inte bara dubbelklicka på en fil
## Metod 3 (Rekommenderad)
ShowMeMyMD — bara dubbelklicka
git clone <repo> Dubbelklicka på README.md Klart.
ShowMeMyMD är en inbyggd macOS Markdown-visare. Ställ in den som standardapp för .md -filer så öppnas varje README som en renderad förhandsgranskning direkt. Inget CLI. Ingen server. Ingen konfiguration.
Fullt GitHub-Flavored Markdown-stöd:
- Tabeller med justering
- Uppgiftslistor med kryssrutor
- Avgränsade kodblock med syntaxmarkering
- GitHub-stilade callouts:
NOTE,TIP,WARNING,IMPORTANT,CAUTION
Klona, dubbelklicka på README.md, klart.
## Jämförelse
Sida vid sida-jämförelse
| Verktyg | Installation | GFM-precision | Hastighet | Offline |
|---|---|---|---|---|
| grip | Python + pip install | Exakt (GitHub API) | Långsam (nätverk) | Nej |
| VS Code | Redan installerat | Delvis | Snabb | Ja |
| ShowMeMyMD | Installera en gång från Mac App Store | Fullt GFM + callouts | Omedelbart | Ja |
## Läs vidare
Läs mer om ShowMeMyMD som Markdown-visare för Mac. Se hur den passar in i ett utvecklararbetsflöde. Eller läs vår guide om GitHub-stilade callouts.
Sluta pusha för att kontrollera din README
Dubbelklicka på valfri .md -fil och se den renderad direkt. GitHub-Flavored Markdown, syntaxmarkering, fyra teman. 2,99 $ på Mac App Store.