En introduktion till Markdown

Prissänkning

Markdown är ett text till HTML-konverteringsverktyg. Idag har det blivit de facto-synonym för en klass av lättviktsmarkeringsbeskrivningsspråk. Den använder en syntax för formatering av vanlig text. Tanken bakom Markdown var att göra det enkelt att skriva webbsidor och särskilt blogginlägg som att skriva ett e-postmeddelande. Vid tidpunkten för november 2017 uppnås målet och Markdown samt dess härledningar Asciidoc, Asciidoctor och Asciidoctor-pdf används i stor utsträckning.

Markdown fokuserar endast på vanlig text och avstår från alla andra komplexiteter som finns i HTML. Det är lätt att lära sig eftersom det hålls enkelt, därför också snabbare eftersom minimala tecken används, vilket leder till mindre chanser för ett fel i slutändan också. Se figur 1 för ett grundläggande dokument som visas i Markdown-redigeraren Stackedit. På vänster sida ser du källkoden och på höger sida motsvarande HTML-utdata. Du kanske märker att rubrikerna helt enkelt är markerade med ett antal nummer enligt rubrikens hierarkinivå.

Textkonvertering

Den klara texten kan konverteras till XHTML (HTML) och många andra format med hjälp av kommandoradsverktygen som Markdown eller Pandoc. I grund och botten skapar båda verktygen endast HTML-fragment och skriver utdata till stdout. Pandoc erbjuder omkopplaren "-o filnamn" för att skriva HTML-utdata till den givna filen. Som ses nedan heter utdatafilen grundläggande.html och innehåller HTML-fragmentet - två rubriker och ett stycke.

$ pandoc -o grundläggande.html basic.md $ katt grundläggande.html 
Skapa Debian-paket HowTo
 
Förord
 Att vara ansvarig för en maskin innebär att ta hand om hårdvaran och mjukvarukomponenterna. Som man ser i vardagen som systemadministratör är det mycket bättre att installera programvara som ett mjukvarupaket snarare än en massa källfiler. Detta minskar kostnaderna för att underhålla systemet ordentligt. $ 

För att skapa fristående HTML-dokument med en komplett HTML-rubrik accepterar Pandoc växeln "-s" enligt följande:

$ pandoc -o grundläggande.html-s grundläggande.md $ katt grundläggande.html           
Skapa Debian-paket HowTo
 
Förord
 Att vara ansvarig för en maskin innebär att man tar hand om både hårdvaran och mjukvarukomponenterna. Som man ser i vardagen som systemadministratör är det mycket bättre att installera programvara som ett mjukvarupaket snarare än en massa källfiler. Detta minskar kostnaderna för att underhålla systemet ordentligt.   

Fördelen med att hålla innehållet åtskilt från din visuella skärm är att det inte förstör utseendet på din webbplats. Version 1.0.1, som utvecklades av John Gruber och Aaron Swartz släpptes i december 2004 och finns som gratis programvara (se länkar i slutet av den här artikeln).

Textelement

Rubriker

Enligt motsvarande HTML-nivå skrivs rubriker med ett antal # på följande sätt:

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 

För H1 och H2 accepteras två alternativa sätt att skriva:

H1 == H2 -- 

Observera att antalet likhetstecken eller streck måste matcha antalet tecken i rubriken.

Betonar text

För att framhäva text stöds dessa element:

• kursiv: enstaka asterisker eller enstaka understrykningar
  --
  * viktigt * och _och viktigt_
  --
• fet text: dubbla asterisker eller dubbla understrykningar
  --
  ** viktigt ** och __och viktigt__
  --
• överstrykad text: dubbla tildes
  --
  ~~ text ~~
  --

Listor

Markdown stöder oordnade och ordnade listor. Beställda listor börjar med en asterisk, ett plus- eller minustecken. Beställda listor börjar bara med en siffra. För att skapa sublistor indrycker listan med två mellanslag (Markdown, StackEdit) eller fyra blanksteg (Pandoc) som du ser nedan:

1. frukt * äpple * banan 2. drycker + vatten + mjölk 

Bilder

Det enklaste sättet är att använda inline-stilen enligt följande:

![Debian-logotypen] (debian-logo.png “Debian-logotyp”) 

Detta visar den refererade bilden. Så snart du flyttar muspekaren över bilden ser du motsvarande beskrivningstext.

Kod- och syntaxmarkering

Det finns två varianter - inline-kod och kodblock. Inbyggd kod är inramad i tre backticks som "'print (" Hello, world!”)“ '. Kodblock börjar och slutar också med tre backticks men på separata rader enligt följande:

"tryck (" Hej världen!”)”

Markdown stöder inte syntaxmarkering men dialekter som Markdown Here gör.

Tabeller

Markdown stöder inte tabeller men tillägg som GFM och Markdown Here gör.

Blockcitat

Blockcitat börjar bara med ett ">" -tecken. Det blir ganska praktiskt att citera text.

> "Åh! det är absurt att ha en hård och snabb regel om vad man ska> läsa och vad man inte borde. Mer än hälften av den moderna kulturen beror på vad man inte borde läsa.">> Vikten av att vara värst. (Oscar Wilde) 

Länkar

Länkar hänvisar till andra dokument eller till avsnitt i det aktuella. Skrivstilen liknar bilder och består av länkbeskrivningen inom hakparenteser och webbadressen inom vanliga parenteser.

[Jag är en inbyggd länk] (https: // linuxhint.com) 

Dessutom kan du lägga till en alternativ text:

[Jag är en integrerad länk med ytterligare text] (https: // linuxhint.com “LinuxHint”) 

Länkar kan hänvisas till enligt följande:

[LinuxHint] [1] ... lite text ... [1]: https: // linuxhint.com 

Detta gör att du enkelt kan skapa referenslistor i slutet av ditt dokument, vilket är vanligt i vetenskapliga dokument.

Slutsats

Markdown är ganska enkelt och ett måste för alla som gör dokumentation och regelbundet publicerar innehåll. Det är ett stort nöje att använda den.

Referenser

• StackEdit, https: // stackedit.io / redaktör
• Pandoc, http: // pandoc.org /
• Markdown, https: // daringfireball.nät / projekt / markdown /
• Markdown Cheatsheet, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet