Introduksjon til Markdown

Introduksjon til Markdown

Markdown

Markdown er en tekst til HTML -konverteringsverktøyet. I dag har det blitt de facto-synonym for en klasse av lett markering Beskrivelse språk. Den bruker en vanlig tekstformateringssyntaks. Ideen bak Markdown var å lage skriving av websider og spesielt bloggoppføringer like enkelt som å skrive en e-post. På tidspunktet for november 2017 oppnås målet og markdown så vel som dets avledninger asciidoc, asciidoctor og asciidoctor-pdf er mye i bruk.

Markdown fokuserer bare på vanlig tekst og avholder seg fra alle andre kompleksiteter som finnes i HTML. Det er lett å lære, da det holdes enkelt, derfor også raskere når minimale karakterer brukes, noe som fører til mindre sjanser for en feil til slutt også. Se figur 1 for et grunnleggende dokument vist i Markdown Editor Stackedit. På venstre side ser du kildekoden og på høyre side den tilsvarende HTML -utgangen. Du kan legge merke til at overskriftene ganske enkelt er merket med et antall #".

Tekstkonvertering

Den vanlige teksten er konvertibel til XHTML (HTML) og mange andre formater som bruker kommandolinjeverktøyene som Markdown eller Pandoc. I utgangspunktet lager begge verktøyene bare HTML -fragmenter og skriver utdataene til stdout. Pandoc tilbyr bryteren "-o filnavn" for å skrive HTML-utgangen til den gitte filen. Som vist nedenfor heter Output -filen Basic.HTML og inneholder HTML -fragmentet - to overskrifter og et avsnitt.

$ pandoc -o grunnleggende.HTML BASIC.MD
$ katt grunnleggende.html

Debian -pakkeoppretting Howto


Forord


Å være ansvarlig for en maskin betyr å ta vare på maskinvaren så vel som programvarekomponentene. Som sett i hverdagen som systemadministrator er det mye bedre å installere programvare som en programvarepakke i stedet for en haug med kildefiler. Dette reduserer kostnadene for å opprettholde systemet på riktig måte.
$

For å lage frittstående HTML-dokumenter med en komplett HTML-overskrift, aksepterer Pandoc bryteren “-S” som følger:

$ pandoc -o grunnleggende.html -s grunnleggende.MD
$ katt grunnleggende.html










Debian -pakkeoppretting Howto


Forord


Å være ansvarlig for en maskin betyr å ta vare på maskinvaren så vel som programvarekomponentene. Som sett i hverdagen som systemadministrator er det mye bedre å installere programvare som en programvarepakke i stedet for en haug med kildefiler. Dette reduserer kostnadene for å opprettholde systemet på riktig måte.

Fordelen med å holde innholdet atskilt fra det visuelle skjermen er at det ikke vil rote utseendet på nettstedet ditt. Versjon 1.0.1, som ble utviklet av John Gruber og Aaron Swartz ble utgitt i desember 2004 og er tilgjengelig som gratis programvare (se lenker på slutten av denne artikkelen).

Tekstelementer

Overskrifter

I henhold til det tilsvarende HTML -nivået er overskrifter skrevet med et antall #'s som følger:

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

For H1 og H2 er to alternative måter å skrive på godt om:

H1
==
H2
--

Vær oppmerksom på at antall like skilt eller streker må samsvare med antall karakterer i overskriften.

Understreker tekst

For å understreke tekst støttes disse elementene:

  • Kursiv: Enkel stjerner eller enkeltundersøkelser
    --
    * viktig* og _ også viktig_
    --
  • Fet tekst: doble stjerner eller dobbeltundersøkelser
    --
    ** VIKTIG ** og __ også viktig __
    --
  • Krysset tekst: Dobbelt tildes
    --
    ~ ~ tekst ~~
    --

Lister

Markdown støtter uordnede og bestilte lister. Bestilte lister begynner med en stjerne, et pluss eller et minustegn. Bestilte lister bare start med et siffer. For å lage sublister innrykk listetem av to mellomrom (Markdown, Stackedit) eller fire mellomrom (PANDOC) som du ser nedenfor:

1. frukt
* eple
* Banan
2. drikke
+ vann
+ melk

Bilder

Den enkleste måten er å bruke inline -stilen som følger:

![Debian-logoen] (Debian-logo.PNG “Debian logo”)

Dette viser det refererte bildet. Så snart du flytter musepekeren over bildet, ser du den tilsvarende beskrivelsesteksten.

Kode og syntakshøydepunkt

Det er to varianter - inline kode- og kodeblokker. Inline -kode er innrammet i tre backticks som “'Print (“ Hallo, World!”)“ '. Kodeblokker starter og slutter også med tre backticks, men på separate linjer som følger:

""
trykk (“Hei, verden!)
""

Markdown støtter ikke syntaksutheving, men dialekter som Markdown her gjør.

Bord

Markdown støtter ikke tabeller, men utvidelser som GFM og Markdown her gjør.

Blockquotes

Blockquotes begynner bare med et ">" -tegn. Det blir ganske nyttig å sitere tekst.

> "Å! Det er absurd å ha en hard og rask regel om hva man skal
> Les og hva man ikke skal. Mer enn halvparten av moderne kultur avhenger
> på hva man ikke skal lese.""
>
> Viktigheten av å være inderlig. (Oscar Wilde)

Lenker

Koblinger refererer til andre dokumenter eller til seksjoner i den nåværende. Skrivestilen ligner på bilder og består av lenkebeskrivelsen i firkantede parenteser og nettadressen i vanlige parenteser.

[Jeg er en lenke i inline-stil] (https: // linuxhint.com)

Videre kan du legge til en alternativ tekst:

[Jeg er en inline-stil lenke med tilleggstekst] (https: // linuxhint.com “Linuxhint”)

Koblinger kan refereres til som følger:

[Linuxhint] [1]
..
Noe tekst
..
[1]: https: // linuxhint.com

Dette lar deg enkelt bygge lister over referanser på slutten av dokumentet, da det er vanlig i vitenskapelige dokumenter.

Konklusjon

Markdown er ganske enkelt og et must for alle som gjør dokumentasjon og regelmessig publiserer innhold. Det er en stor glede å bruke den.

Referanser

  • Stackedit, https: // stackedit.io
  • Pandoc, http: // pandoc.org/
  • Markdown, https: // Daringfireball.netto/prosjekter/markdown/
  • Markdown Cheatheet, https: // github.com/adam-p/markdown-her/wiki/markdown-cheatark