Phenquestions
Een inleiding tot Markdown
Markdown
Markdown is een tekst-naar-HTML-conversietool. Tegenwoordig is het het de facto-synoniem geworden voor een klasse van lichtgewicht opmaaktalen voor de beschrijving. Het gebruikt een syntaxis voor de opmaak van platte tekst. Het idee achter Markdown was om het schrijven van webpagina's en vooral blogberichten net zo eenvoudig te maken als het schrijven van een e-mail. Op het moment van november 2017 is het doel bereikt en worden zowel Markdown als zijn afleidingen Asciidoc, Asciidoctor en Asciidoctor-pdf op grote schaal gebruikt.
Markdown richt zich alleen op platte tekst en onthoudt zich van alle andere complexiteiten zoals gevonden in HTML. Het is gemakkelijk te leren omdat het eenvoudig is gehouden, dus ook sneller omdat er minimale tekens worden gebruikt, wat uiteindelijk ook leidt tot minder kans op fouten. Zie figuur 1 voor een basisdocument dat wordt getoond in de Markdown-editor Stackedit. Aan de linkerkant zie je de broncode en aan de rechterkant de bijbehorende HTML-output. Het is u misschien opgevallen dat de koppen eenvoudig zijn gemarkeerd met een aantal #'s volgens het hiërarchieniveau van de kop.
Tekstconversie
De platte tekst kan worden geconverteerd naar XHTML (HTML) en vele andere formaten met behulp van de opdrachtregelprogramma's zoals Markdown of Pandoc. Kortom, beide tools maken alleen HTML-fragmenten en schrijven de uitvoer naar stdout. Pandoc biedt de schakelaar "-o bestandsnaam" om de HTML-uitvoer naar het opgegeven bestand te schrijven. Zoals hieronder te zien is, heet het uitvoerbestand basic.html en bevat het HTML-fragment - twee koppen en een alinea.
$ pandoc -o basic.html basis.md $ cat basic.htmlDebian Pakketaanmaak HowTobian
Voorwoord
Verantwoordelijk zijn voor een machine betekent zorgen voor zowel de hardware als de softwarecomponenten. Zoals we in het dagelijks leven als systeembeheerder zien, is het veel beter om software als een softwarepakket te installeren in plaats van een heleboel bronbestanden. Dit verlaagt de kosten om het systeem goed te onderhouden. $
Om stand-alone HTML-documenten met een volledige HTML-header te maken, accepteert Pandoc de schakelaar "-s" als volgt:
$ pandoc -o basic.html -s basis.md $ cat basic.html
Debian Pakketaanmaak HowTobian
Voorwoord
Verantwoordelijk zijn voor een machine betekent zorgen voor zowel de hardware als de softwarecomponenten. Zoals we in het dagelijks leven als systeembeheerder zien, is het veel beter om software als een softwarepakket te installeren in plaats van een heleboel bronbestanden. Dit verlaagt de kosten om het systeem goed te onderhouden.
Het voordeel van het gescheiden houden van de inhoud van uw visuele weergave is dat het het uiterlijk van uw site niet zal verpesten. Versie 1.0.1, die werd ontwikkeld door John Gruber en Aaron Swartz, werd uitgebracht in december 2004 en is beschikbaar als gratis software (zie links aan het einde van dit artikel).
Tekstelementen
Krantenkoppen
Volgens het overeenkomstige HTML-niveau worden koppen als volgt geschreven met een aantal #'s:
# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6
Voor H1 en H2 worden twee alternatieve schrijfwijzen geaccepteerd:
H1 == H2 --
Houd er rekening mee dat het aantal gelijktekens of streepjes moet overeenkomen met het aantal tekens van de kop.
Tekst benadrukken
Om tekst te benadrukken worden deze elementen ondersteund:
- cursief: enkele sterretjes of enkele underscores
--
*belangrijk* en _ook belangrijk_
-- - vetgedrukte tekst: dubbele sterretjes of dubbele onderstrepingstekens
--
**belangrijk** en __ook belangrijk__
-- - doorgestreepte tekst: dubbele tildes
--
~~tekst~~
--
Lijsten
Markdown ondersteunt ongeordende en geordende lijsten. Geordende lijsten beginnen met een asterisk, een plus- of een minteken. Geordende lijsten beginnen gewoon met een cijfer. Om sublijsten te maken, springt u het lijstitem in met twee spaties (Markdown, StackEdit) of vier spaties (Pandoc) zoals u hieronder ziet:
1. fruit * appel * banaan 2. dranken + water + melk
Afbeeldingen
De eenvoudigste manier is om de inline-stijl als volgt te gebruiken:
Dit geeft de afbeelding waarnaar wordt verwezen. Zodra u de muisaanwijzer over de afbeelding beweegt, ziet u de bijbehorende beschrijvingstekst.
Markering van code en syntaxis
Er zijn twee varianten - inline code en codeblokken. Inline-code is omlijst met drie backticks zoals "'print ("Hallo, wereld!)“'. Codeblokken beginnen en eindigen ook met drie backticks, maar op afzonderlijke regels als volgt:
"afdrukken ("Hallo wereld!”)" Markdown ondersteunt geen syntaxisaccentuering, maar dialecten zoals Markdown Here wel.
Tafels
Markdown ondersteunt geen tabellen, maar extensies zoals GFM en Markdown Here wel.
Blok citaten
Blokquotes beginnen gewoon met een ">" teken. Het wordt best handig om tekst te citeren.
> "Oh! het is absurd om een vaste regel te hebben over wat je wel en niet moet lezen >. Meer dan de helft van de moderne cultuur hangt af > van wat men niet mag lezen." > > Het belang van serieus zijn. (Oscar Wilde)
Links
Links verwijzen naar andere documenten of naar secties in de huidige. De schrijfstijl is vergelijkbaar met afbeeldingen en bestaat uit de linkbeschrijving tussen vierkante haken en de URL tussen gewone haken.
[Ik ben een inline-stijl link](https://linuxhint.com)
Verder kunt u een alternatieve tekst toevoegen:
[Ik ben een inline-achtige link met extra tekst](https://linuxhint.com "LinuxHint")
Er kan als volgt naar links worden verwezen:
[LinuxHint][1]… wat tekst… [1]: https://linuxhint.com
Hierdoor kunt u eenvoudig referentielijsten aan het einde van uw document maken, zoals gebruikelijk is in wetenschappelijke documenten.
Conclusie
Markdown is vrij eenvoudig en een must voor iedereen die documentatie maakt en regelmatig inhoud publiceert. Het is een groot genoegen om het te gebruiken.
Referenties
- StackEdit, https://stackedit.io/editor
- Pandoc, http://pandoc.org/
- Markdown, https://daringfireball.netto/projecten/afwaardering/
- Markdown Cheatsheet, https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
