Markdownissa

Markdown on kevyt merkkauskieli, jonka tarkoituksena on tehdä tekstin kirjoittamisesta sekä luettavaa että helposti HTML:ksi muunnettavaa. Sen idea on säilyttää raakatekstin luettavuus ja välttää raskaita merkkaussääntöjä. Markdownin loi John Gruber vuonna 2008 yhteistyössä Aaron Swartzin kanssa.

Perusasiat: otsikot merkitään alussa olevilla # -merkeillä, korostus tehdään tähdillä tai alaviitteillä (kursiivi yhdellä tähdellä tai alaviitteellä, lihavointi kahdella tähdellä). Listat voivat olla järjestettyjä tai epäjärjestettyjä, merkitään viivoilla, pisteillä tai numerosarjoilla. Linkit kirjoitetaan muodossa [nimi](url). Kuvat seuraavat samanlaista syntaksia lisäysmerkinnällä . Koodin voi sijoittaa yksittäisen rivin backtickillä tai pidempiä koodilohkoja kolmen backtickin sisään. Lainaukset aloitetaan >-merkillä, ja vaakaviivat voidaan lisätä kolmantena merkkinä.

Standardointi ja variantit: Markdown ei ole yksi virallinen standardi, vaan erilaisia versioita. CommonMark on laajasti käytetty vakiokriteeri, jonka tarkoituksena on ratkaista syntaksin epäselvyydet. GitHub Flavored Markdown, MultiMarkdown ja Pandoc ovat suosittuja laajennuksia, jotka tuovat lisäominaisuuksia kuten taulukot, tehtävälistat ja viitteet. Eri renderöijät voivat tulkita merkintöjä hieman eri tavoin.

Käyttö ja työkalut: Markdownia käytetään yleisesti dokumentaatiossa, README-tiedostoissa sekä verkkosisällössä. Tiedostopääte on usein .md tai .markdown. Monet editorit tukevat syntaksin korostusta ja esikatselua, ja lukuisat staattiset sivugeneraattorit sekä sisällönhallintajärjestelmät käyttävät Markdownia sisällön lähteenä.

Rajoitteet: perusversio on kevyt eikä tue kaikkia monimutkaisia rakenteita ilman flavor-tukea. Taulukot, viitteet ja tehtävälistat voivat olla saatavilla vain tietyillä laajennoksilla. Projektin kannalta on suositeltavaa valita käytössä oleva flavor ja noudattaa sitä, jotta renderöinti pysyy johdonmukaisena.