Indrag i Markdown: nästlade listor, stycken och kod
Rätta Markdown-indrag med exempel på nästlade punkter, numrerade listor, fortsättningsstycken och inhägnad kod. Undvik oavsiktliga kodblock.
För att göra indrag för en Markdown-underlista placerar du dess markör under det första tecknet i den överordnade punktens text. För - Överordnad punkt betyder det två blanksteg. För 1. Överordnad punkt betyder det tre. Indrag styr dokumentstrukturen, så blanksteg framför ett vanligt stycke kan ha en helt annan effekt än att ändra det visuella indraget i ett Word-stycke.
Börja med det här exemplet i Markdown-visaren:
- Projektdokument
- Installationsguide
- Versionsinformation
- Granskningschecklista
Installationsguiden och versionsinformationen ska visas under punkten för projektdokument. Granskningschecklistan ska ligga kvar på den yttre nivån.
Räkna från den överordnade punktens innehåll
För vanliga listpunkter med ett blanksteg efter markören använder du den här justeringsguiden:
| Överordnad punkt börjar med | Tecken före dess text | Underlistans indrag |
|---|---|---|
- | 2 | 2 blanksteg |
1. | 3 | 3 blanksteg |
12. | 4 | 4 blanksteg |
100. | 5 | 5 blanksteg |
Därför fungerar inte en generell regel som ”använd alltid två blanksteg” för numrerade listor. GitHubs dokumentation om nästlade listor visar justering i förhållande till det överordnade innehållet, även med längre siffermarkörer.
1. Förbered utgåvan
- Bekräfta versionsnumret.
- Uppdatera ändringsloggen.
2. Publicera dokumentationen
De nästlade markörerna har tre inledande blanksteg. Om de börjar vid vänstermarginalen inleder de en separat lista i stället för att tillhöra det första numrerade steget.
När du arbetar med en äldre Markdown-processor bör du förhandsvisa filen där också. Exemplen här riktar sig till CommonMark-liknande tolkning och GitHub Markdown; äldre implementationer kan känna igen nästlade block på andra sätt.
Lägg till ett stycke inom en listpunkt
En längre förklaring behöver ingen egen punktmarkör. Lämna en tom rad och placera sedan det nya stycket under punktens text:
1. Granska installationsguiden.
Bekräfta att en ny läsare kan slutföra installationen utan
att öppna ett internt dokument.
2. Godkänn versionsinformationen.
Det förklarande stycket hör till steg ett. Dess två källtextrader flyter samman om du inte lägger till en uttrycklig radbrytning.
Om de tre blankstegen saknas kan den numrerade listan avslutas och förklaringen bli ett vanligt stycke. Det kan även få nästa lista att börja om numreringen i vissa redigeringsflöden.
Samma mönster fungerar med punktlistor:
- Installationsguide
Ta med förutsättningar, installationskommandon och ett verifieringssteg.
- Versionsinformation
Använd ett separat stycke när förklaringen innehåller flera meningar. Använd en underlista när den innehåller skilda punkter som läsarna ska kunna överblicka var för sig.
Placera kod inom ett numrerat steg
Inhägnad kod gör gränsen för ett kommandoexempel synlig. Gör indrag för den öppnande avgränsaren, innehållet och den avslutande avgränsaren för att behålla blocket inom listpunkten:
1. Kontrollera den installerade versionen.
```sh
node --version
```
Anteckna resultatet i granskningsanteckningarna.
2. Kör projektkontrollerna.
Här börjar avgränsaren under den första bokstaven i Kontrollera. Stycket efter avgränsaren använder samma placering och stannar därför också inom det första steget.
Om nästa numrerade steg blir en del av kodblocket granskar du den avslutande avgränsaren. Om koden hamnar utanför listan kontrollerar du avgränsarens inledande blanksteg. Se guiden till kodblock för språketiketter och bokstavliga gravaccenttecken.
Varför fyra blanksteg kan göra text till kod
På dokumentets yttre nivå kan fyra blanksteg före en rad efter en tom rad skapa ett indraget kodblock:
Ett vanligt stycke.
Den här raden visas som kod.
Det är avsiktlig Markdown-syntax och inte ett trasigt indragsreglage. CommonMarks referens för indragna kodblock förklarar rollen för indrag och blockgränser.
En indragen rad direkt efter vanlig stycketext har andra tolkningsvillkor, så att lägga in blanksteg är inget tillförlitligt sätt att skapa ett visuellt styckeindrag. Inuti listor räknas de nödvändiga blankstegen dessutom i förhållande till den omgivande punkten.
Använd ett blockcitat för ett citat. För vanlig löptext som behöver indrag på första raden i en slutlig rapport behåller du ett normalt stycke i Markdown och tillämpar styckeformateringen i Word efter exporten. De valen bevarar innehållets avsedda betydelse.
Föredra blanksteg vid felsökning
Tabbtecken kan ta upp flera visningskolumner, och olika redigerare kan visa dem med olika bredd. Om en lista ser justerad ut i källtexten men renderas fel visar du blanktecken i redigeraren och ersätter inledande tabbar med det antal blanksteg som krävs.
Ersätt inte tabbar inuti kodexempel urskillningslöst. Där kan blanktecknen vara en del av själva exemplet. Begränsa rensningen till Markdown-markörerna och fortsättningsindragen som bestämmer den omgivande liststrukturen.
Undvik upprepade entiteter för fasta blanksteg för att imitera en nästlad lista. Det kan få text att se förskjuten ut i en förhandsvisning medan dokumentet fortfarande består av orelaterade stycken.
Verifiera strukturen före Word-export
Granska ett representativt avsnitt med en överordnad punkt, en underlista, ett andra stycke och ett inhägnat kodblock. I Markdown-till-HTML-konverteraren ligger en riktig nästlad lista inuti sin överordnade listpunkt; enbart en visuell förskjutning skapar inte det sambandet.
Använd sedan Markdown-till-Word-konverteraren och öppna DOCX-filen. Kontrollera att numreringen fortsätter som avsett och att kommandon fortfarande hör ihop med sina steg. Words listformat kan använda andra visuella avstånd än webbläsaren, så bedöm både hierarkin och slutdokumentets utseende innan du delar det.