Markdown Tutorial - Fra oppsett til syntaks

Markdown er en lettlest og lett å lære markeringsspråk. I motsetning til HTML, XML eller andre markeringsspråk, der det sinnssyke antallet obskure tagger får det til å se utilnærmelig ut, er Markdown svært lesbar selv som en rå tekstfil.

Samtidig er markdown også veldig lett og fleksibel. Den mest populære brukssaken for Markdown er for lisens- og readme -filer i et GitHub -depot, men det blir også integrert med flere og flere CMS for å administrere blogginnlegg, og til og med skrive forskningsartikler. Du kan gjengi matematiske ligninger med plugins for latex.

Det brukes imidlertid hovedsakelig av utviklere. Det er veldig nyttig å lage opplæringsprogrammer og dokumentasjon takket være syntaks som fremhever for flere språk og støtte for bilder og til og med GIF -er.

La oss starte med et oppsett som lar oss forhåndsvise det gjengitte dokumentet sammen med en rå markdown -tekstfil.

Atom Text Editor and Markdown Preview

Du kan laste ned og installere Atom Text Editor eller Visual Studio Code for å følge med. Atom og VS-kode har begge forhåndsinstallerte plugins for forhåndsvisning av Markdown. Her vil Atom bli brukt, men syntaks vil forbli omtrent det samme uansett hvilken tekstredigerer du bruker.

På atom, sørg for at Preview -pakken for Markdown er aktivert (den er faktisk aktivert som standard). Lag en mappe for denne Markdown -opplæringen, og der inne, åpne en ny fil (Ctrl + N) og skriv inn følgende tekst der inne.

# Dette er en overskrift
___
## Dette er også en overskrift
Her er litt tekst

Lagre filen (CRTL + S) med en .MD -forlengelse. For eksempel kan du navngi filen din som test.MD og .MD -del vil fortelle Atom at dette er en markdown -fil og utvidelsen vil fungere med den som ment. Du kan generere en forhåndsvisning ved å bruke følgende KeyBinding (Ctrl+Shift+M) som vises i en ny rute ved siden av rå tekstfilen.

Du kan lukke forhåndsvisningsruten ved å bruke den samme nøkkelbindingen eller ved å bruke GUI selv.

Med alt satt opp kan vi se nærmere på syntaksen og begynne å lage fantastiske dokumenter på farten.

Markdown -syntaks

Som nevnt tidligere er hovedmotivasjonen bak markdown lesbarhet. Dette betyr ingen obskure tagger eller nestede tagger eller annen forvirring som induserer strenger. I stedet kan vi starte med '#' -symbol for å indikere at den aktuelle linjen er en overskrift.

# Er en overskrift.
## indikerer også overskrift, men med mindre skriftstørrelse.
### Du kan gå videre til sammenhengende mindre størrelser

Linjepauser

Markdown fortsetter å klumpe all teksten til ett gigantisk avsnitt selv når råteksten er delt inn i flere forskjellige linjer. For å dempe dette, kan du bruke to mellomrom på slutten av en linje og deretter sette en ny line -karakter (det vil si hit ) eller bare bruk to Newline -tegn for en litt annen effekt som vist nedenfor.

Setningen “Det er grunnen til.

Horisontal regel

Horisontal regel skaper, som navnet antyder, en horisontal linje som lar deg strukturere dokumentet ditt og gjøre logiske separasjoner i det. Det er to metoder for å lage en horisontal regel. Først er det å bruke tre eller flere understreker for å lage en horisontal regel.

#Heading 1
___
Avsnitt og overskrift er atskilt med en horisontal regel.
___
En annen adskilt seksjon

Et annet alternativ (som jeg ikke vil anbefale) er å bruke tre eller flere streker '-' men de brukes også til å indikere at setningen rett over dem er en overskrift. Så hvis du ikke har en ny linje mellom en setning og den horisontale regelen under den, vil den setningen ta form av en overskrift.

Kursiv, dristig og streik

Syntaksen for de tre av disse er ganske enkel og snakker for seg selv.

** dette er i fet **
__ Dette er også dristig__
_ Dette er kursiv
*Dette er også kursiv*
~~ Dette er streik ~ ~

Rømningskarakter

Nå kan man spørre, hvordan vil du bokstavelig talt skrive ** litt tekst ** inn i den endelige markdown -filen hvis den bare endrer det for å fete hver gang. Dette er noe som de fleste programmeringsspråk også takler, og løsningen ligner på disse - bruk en tilbakeslagskarakter. Dette fungerer for andre syntakselementer også, og er ikke spesielt for dristig styling.

\ ** Dette er ikke lenger dristig \ **
Hvis du vil vise selve tilbakeslagskarakteren, bruk to av dem og så videre.
\\ dukker opp som en enkelt skråstrek

Blockquotes og kodeblokker

Blockquotes og kodeblokker er mye enklere. En blockquote kan brukes til å fremheve et viktig punkt som du vil trekke lesernes oppmerksomhet. Dette kan oppnås ved å bruke høyre vinkelbrakett i starten som vist.

# Overskrift 1
Lorem ipsum dolor sit amet, consectetur adipising elit, sed do eiusmod tempor incidunt ut
Labore et Dolore Magna Aliqua. Ut enim ad minim Veniam, Quis Nostrud -utøvelse Ullamco Laboris
nisi ut aliquip ex ea commodo konsekvens. Duis Aute Irure Dolor i Reprehenderit in Voluptate
Velit Esse Cillum Dolore Eu Fugiat Nulla Pariature. Unntatt Sint occaecat cupidatat non
Proident, sunt i Culpa qui officia deserunt mollit anim id est laborum.
> Dette er et pent sammendrag av et underavsnitt av dokumentet ditt. Et> par linjer som står
ut fra resten av innholdet.
Innholdet fortsetter.

Slik ser det ut når det blir gjengitt.

For kodeblokker, bare innrykk linjene linjene med 4 mellomrom eller mer. Dette er virkelig

praktisk for utviklere og operatører som vil dokumentere arbeidet sitt. Vi ville senere se hvordan vi skal gjøre dette enda bedre.

Hyperkoblinger og bilder

For hyperkoblinger er syntaksen ganske enkel. Den synlige teksten er skrevet i firkantede parenteser, og URLen som den peker til er skrevet i runde parenteser rett ved siden av.

For bilder er syntaksen lik, bortsett fra at den starter med et utropstegn. Du står fritt til å bruke en relativ bane i prosjektmappen din som peker på bildet, eller du kan ha en offentlig url.

## illustrere hyperkobling og bildesyntaks
___
Du bør [besøke oss] (https: // linuxhint.com) oftere
Slik er bilder innebygd.
![Smugpug] (https: // opplasting.Wikimedia.org/wikipedia/commons/d/d2/bonny_bonita.Jpg)

Bord

Å lage tabeller i markdown inkluderer bokstavelig talt å tegne et ASCII (Unicode for å være presis) portrett av et bord.

## Tabeller
| Kolonne 1 | Kolonne 2 | Kolonne 3 |
| --------- | --------- | --------- |
| Første rad | Første rad | Første rad |
| Andre rad | Andre rad | Andre rad |

Syntaksen trenger ikke å være nøyaktig rettet fra en rad til en annen, men rørkarakteren brukes til å bytte over til neste kolonne og neste linje indikerer at neste rad har startet, generelt.

Utvidet markdown

For de av dere som har kommet så langt, her er den virkelige godbiten. Hvis du bruker Atom, kan du faktisk erstatte Markdown Preview Plugin for Markdown Preview Plus. Som tilbyr følgende funksjonaliteter.

1. Matematiske ligninger ved bruk av latex:

Du kan faktisk sette inn latexskript mellom dollartegn, og det vil bli gjengitt som latexskript og vist i forhåndsvisningen med Ctrl+Shitft+X KeyBinding. Du trenger ikke engang å vite alle latexene, bare noen få utdrag er nok.

## illustrere latex
___
$$ | \ psi \ rangle = \ alpha | 0 \ rangle + \ beta | \ Rangle $$

2. Syntaksutheving

I stedet for å bruke innrykk for å indikere kodeblokker, kan du faktisk bruke backticks etterfulgt av navnet på språkene som skriptet ditt visstnok er skrevet i. Språkene hvis syntaks støttes er for mange til å liste opp her, men her er et eksempel i Python.

## illustrere syntakshøydepunkt
___
"Python
importere dette
def my_function ():
trykk ("Hei, verden!")
retur 0
""

Det er mange smaker eller markdown. Github har sitt eget spesielle brygg og syntaksen er veldig fleksibel. Dette er ikke ment å skremme brukerne, men å imøtekomme et bredere utvalg av dem. Det er et av disse språkene at man bare forstår et undergruppe som man trenger og bruker det, i stedet for å bli plaget av tekniskheten (med mindre du er interessert i dets tekniske forhold!)