En introduktion til Markdown

Markdown

Markdown er et tekst til HTML konverteringsværktøj. I dag er det blevet de facto-synonym for en klasse af lette markup-beskrivelsessprog. Det bruger en syntaks til formatering af almindelig tekst. Ideen bag Markdown var at gøre det nemt at skrive websider og især blogindlæg som at skrive en e-mail. På tidspunktet for november 2017 nås målet, og Markdown såvel som dets afledninger Asciidoc, Asciidoctor og Asciidoctor-pdf er meget i brug.

Markdown fokuserer kun på almindelig tekst og afholder sig fra alle andre kompleksiteter, som de findes i HTML. Det er let at lære, da det holdes enkelt, derfor også hurtigere, da der bruges minimale tegn, hvilket også fører til mindre chancer for en fejl i sidste ende. Se figur 1 for et grundlæggende dokument vist i Markdown-editoren Stackedit. På venstre side ser du kildekoden og i højre side den tilsvarende HTML-output. Du bemærker muligvis, at overskrifterne simpelthen er markeret med et antal # i henhold til hierarkiniveauet i overskriften.

Tekstkonvertering

Den almindelige tekst kan konverteres til XHTML (HTML) og mange andre formater ved hjælp af kommandolinjeværktøjerne som Markdown eller Pandoc. Dybest set opretter begge værktøjer kun HTML-fragmenter og skriver output til stdout. Pandoc tilbyder omskifteren “-o filnavn” til at skrive HTML-output til den givne fil. Som det ses nedenfor, kaldes outputfilen grundlæggende.html og indeholder HTML-fragmentet - to overskrifter og et afsnit.

$ pandoc -o basic.html basic.md $ kat grundlæggende.html 
Oprettelse af Debian-pakke HowTo
 
Forord
 At være ansvarlig for en maskine betyder at tage sig af både hardware og softwarekomponenter. Som det ses i hverdagen som systemadministrator, er det meget bedre at installere software som en softwarepakke snarere end en masse kildefiler. Dette reducerer omkostningerne til korrekt vedligeholdelse af systemet. $ 

For at oprette enkeltstående HTML-dokumenter med en komplet HTML-overskrift accepterer Pandoc switchen "-s" som følger:

$ pandoc -o basic.html-s grundlæggende.md $ kat grundlæggende.html           
Oprettelse af Debian-pakke HowTo
 
Forord
 At være ansvarlig for en maskine betyder at tage sig af både hardware og softwarekomponenter. Som det ses i hverdagen som systemadministrator, er det meget bedre at installere software som en softwarepakke snarere end en masse kildefiler. Dette reducerer omkostningerne til korrekt vedligeholdelse af systemet.   

Fordelen ved at holde indholdet adskilt fra din visuelle skærm er, at det ikke ødelægger udseendet på dit websted. Version 1.0.1, som blev udviklet af John Gruber og Aaron Swartz, blev udgivet i december 2004 og er tilgængelig som gratis software (se links i slutningen af ​​denne artikel).

Tekstelementer

Overskrifter

I henhold til det tilsvarende HTML-niveau skrives overskrifter med et antal # som følger:

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

For H1 og H2 accepteres to alternative skrivemåder:

H1 == H2 -- 

Bemærk, at antallet af ens tegn eller bindestreger skal matche antallet af tegn i overskriften.

Fremhæver tekst

For at fremhæve tekst understøttes disse elementer:

• kursiv: enkelt stjerner eller enkelt understregning
  --
  * vigtigt * og _ også vigtigt_
  --
• fed tekst: dobbelt stjerne eller dobbelt understregning
  --
  ** vigtigt ** og __ også vigtigt__
  --
• overstreget tekst: dobbelt tildes
  --
  ~~ tekst ~~
  --

Lister

Markdown understøtter uordnede og ordnede lister. Ordnede lister begynder med en stjerne, et plus- eller minustegn. Bestilte lister starter bare med et ciffer. For at oprette underlister indrykkes listen over to mellemrum (Markdown, StackEdit) eller fire mellemrum (Pandoc) som du ser nedenfor:

1. frugt * æble * banan 2. drikkevarer + vand + mælk 

Billeder

Den nemmeste måde er at bruge den integrerede stil som følger:

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

Dette viser det refererede billede. Så snart du bevæger musemarkøren over billedet, ser du den tilsvarende beskrivelsestekst.

Kode og syntaks fremhævning

Der er to varianter - inline-kode og kodeblokke. Inline-kode er indrammet i tre backticks som “'print (“ Hello, world!”)“ '. Kodeblokke starter og slutter også med tre backticks, men på separate linjer som følger:

"print (" Hej verden!”)”

Markdown understøtter ikke syntaksfremhævning, men dialekter som Markdown Here gør.

Tabeller

Markdown understøtter ikke tabeller, men udvidelser som GFM og Markdown Here gør.

Blockquotes

Blockquotes starter bare med et ">" tegn. Det bliver ret praktisk at citere tekst.

> "Åh! det er absurd at have en hård og hurtig regel om, hvad man skal> læse, og hvad man ikke bør. Mere end halvdelen af ​​den moderne kultur afhænger> af, hvad man ikke skal læse.">> Betydningen af ​​at være ørst. (Oscar Wilde) 

Links

Links henviser til andre dokumenter eller til sektioner i den aktuelle. Skrivestilen ligner billeder og består af linkbeskrivelsen i firkantede parenteser og URL'en i almindelige parenteser.

[Jeg er et indbygget link] (https: // linuxhint.com) 

Desuden kan du tilføje en alternativ tekst:

[Jeg er et integreret link med yderligere tekst] (https: // linuxhint.com “LinuxHint”) 

Links kan henvises til som følger:

[LinuxHint] [1] ... noget tekst ... [1]: https: // linuxhint.com 

Dette giver dig mulighed for nemt at oprette lister over referencer i slutningen af ​​dit dokument, som det er almindeligt i videnskabelige dokumenter.

Konklusion

Markdown er ret simpelt og et must for alle, der laver dokumentation og regelmæssigt offentliggør indhold. Det er en stor fornøjelse at bruge det.

Referencer

• StackEdit, https: // stackedit.io / editor
• Pandoc, http: // pandoc.org /
• Markdown, https: // daringfireball.net / projekter / markdown /
• Markdown Cheatsheet, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet