Markdown

Kokeneet kirjoittajat eivät ole vielä tarkistaneet sivun nykyistä versiota, ja se voi poiketa merkittävästi 22.6.2022 tarkistetusta versiosta . tarkastukset vaativat 6 muokkausta .
Markdown
Laajennus .md,
.markdown[1]
MIME -tyyppinen teksti/merkintä [5]
Kehittäjä John Gruber
julkaistu 19. maaliskuuta 2004 [2] [3] ( 19.3.2004 )
Viimeisin julkaisu 17. joulukuuta 2004  ( 17.12.2004 )
Muototyyppi Merkintäkieli
avoin muoto ? kyllä ​​[4]
Verkkosivusto daringfireball.net/proje…
 Mediatiedostot Wikimedia Commonsissa

Markdown ( MPA : [ ˈ m ɑ ː k d a ʊ n ], äännetään markdown ) on kevyt merkintäkieli , joka on suunniteltu ilmaisemaan muotoilut pelkällä tekstillä säilyttäen samalla sen ihmisen luettavuuden mahdollisimman hyvin ja soveltuu koneelliseen muuntamiseen kieliksi edistyneille julkaisuille ( HTML , Rich Text ja muut).

Historia

Alun perin vuonna 2004 luoneet John Gruber ja Aaron Schwartz . Monet kieliideat on lainattu sähköposteissa olevista tekstin merkintäkäytännöistä . Markdown-kielen toteutukset muuntaa Markdown-tekstin kelvolliseksi , hyvin muotoilluksi XHTML :ksi ja korvaa vasemmat kulmasulkeet ("<") ja et -merkit ("&") asianmukaisilla entiteettikoodeilla. Markdownin ensimmäinen toteutus oli Gruberin Perl -toteutus , mutta monia kolmannen osapuolen toteutuksia on ilmestynyt ajan myötä (katso alla ). Perl - toteutus jaetaan BSD - tyyppisen lisenssin alla . Markdownin toteutukset eri ohjelmointikielillä sisältyvät (tai ovat saatavilla laajennuksina ) moniin sisällönhallintajärjestelmiin .

Syntaksiesimerkit

Seuraavat ovat esimerkkejä Markdownin käytöstä, mutta tämä ei suinkaan ole täydellinen opas. Kielen täydellinen kuvaus löytyy viralliselta verkkosivustolta [6] . Merkit, joita yleensä käsitellään erityisinä Markdownissa, voidaan ohittaa kenoviivalla . Esimerkiksi sekvenssi "\*" näyttää merkin "*", eikä se ole merkki valitun tekstin alusta. Markdown ei myöskään muunna tekstiä "raakojen" XHTML-lohkojen sisällä. Siten XHTML-osiot voidaan sisällyttää Markdown-asiakirjaan käärimällä ne ensin lohkotason tageihin.

Teksti korostettuna tai loogisesti korostettuna

*korostus* (esim. kursivoitu) **voimakas painotus** (esim. lihavoitu)

Ohjelmakoodi

Koodielementit voivat olla rivin sisällä (inline) tai monirivisissä lohkoissa.

Merkkijonon sisällä koodi on korostettu "`"-merkillä ( backtick ).

Koodiesimerkki rivin sisällä (inline) "Hei maailma!"

Monirivinen koodilohko on merkitty 4 välilyönnillä tai yhdellä sarkaimella .

Alla alkaa monirivinen koodilohko <!doctypehtml> <html> <pää> <!-- Asiakirjan otsikko --> </head> <body> <!-- Asiakirjan runko --> </body> </html> Koodilohko päättyi

Yliviivattu teksti

sinun täytyy tehdä ~~yksi asia~~ toinen asia

Listat

* luettelomerkitty luetteloelementti - toinen järjestämätön luetteloelementti + elementtimerkit voivat olla erilaisia 1. Numeroitu luettelo 2. Saman luettelon kohta 2 9. Luettelon kohta 3 - elementit on numeroitu järjestyksessä, rivin alussa olevalla numerolla ei ole väliä

Otsikot

Otsikot luodaan asettamalla puntamerkki otsikkotekstin eteen. "#"-merkkien määrä vastaa otsikkotasoa. HTML tarjoaa 6 tasoa otsikoita.

# Ensimmäisen tason otsikko ... ### Kolmannen tason otsikko ... ###### Tason 6 otsikko

Kahdella ensimmäisellä otsikkotasolla on myös vaihtoehtoinen syntaksi:

Ensimmäisen tason otsikko ========================= Toisen tason otsikko -------------------------

Lainaukset (blockquote tag)

> Tämä teksti kääritään HTML-tunnisteisiin <blockquote></blockquote>

Linkit

[ Linkin teksti ]( http://example.com/ "Valinnainen linkin otsikko" )

vaihtoehtoinen tapa asettaa linkkejä, jos toistoja esiintyy

Jossain tekstissä on [ linkkiteksti ][ esimerkki ]. Myös linkki toistetaan [ esimerkkiosoite ][ esimerkki ]. Linkki [ second ][ foo ] myös [ Bar ][] resursseihin. [ esimerkki ]: http://example.com/ "Valinnaisen linkin otsikko" [ foo ]: http://example.net/ 'Valinnaisen linkin otsikko' [ palkki ]: http://example.edu/ (Valinnaisen linkin otsikko )

Kuvat

![ Vaihtoehtoinen teksti ]( http://example.com/ "Kuvan otsikko" )

Markdownin toteutukset

Laajennukset

Seuraavat sovellukset toteuttavat Markdownin ja laajentavat sen syntaksia lisätoiminnoilla:

  • MultiMarkdown (C) [32]
  • Text::MultiMarkdown (Perl) -moduuli, joka toteuttaa MultiMarkdown-laajennuksen [33]
  • PHP Markdown Extra [34]
  • python-markdown2 (Tukee joitain PHP Markdown -laajennuksia) [27]
  • python-markdown (Siellä on laajennusjärjestelmä uuden syntaksin lisäämiseksi) [26]
  • Markout (Java) [35]
  • Pegdown (Java) [18]
  • Maruku (rubiini) [29]
  • Pandoc (Haskell) [16] [36]

Oppaat

  • Markdown: Dingus-verkkomuunnin [37]
  • Markdown-huijauslehti [38]

Muuntimet

  • HTML:stä Markdowniin
    • html2text.py (kirjoitettu Pythonilla ) [39]
    • Markdownify ( PHP :ssa ) [40]
    • Make.text on kirjanmerkki , joka muuntaa minkä tahansa verkkosivun Markdowniksi [41]
    • XHTML-to-Markdown XSLT (XSLT-tyylitaulukko, toimii vain XHTML:n kanssa) [42]
    • Pandoc  on Haskell -muodon muunnoskirjasto, joka tukee useita Markdown-murteita ( markdown - pandoc-murre, markdown_strict alkuperäinen Markdown ilman laajennuksia, PHPmarkdown_phpextra  -murre , githubin  murre ), joka voi muuntaa Markdown-, HTML- , reStructuredText- , LaTeX- ja muiden kielistä ja sellaisiksi. [16]markdown_github
  • Muut muodot Markdownissa

Apuohjelmat

Markdownia käyttävät verkkosovellukset

  • Wiki :
  • Blogit :
    • Tumblr  - aluksi poissa käytöstä, mutta sitä voidaan käyttää ottamalla se käyttöön asetuksissa.
    • scriptogr.am
  • CMS :
    • Drupal  – Markdown-sisältösuodatin [46]
    • Magento  - moduulin avulla [47]
    • Plone  – natiivi tuki Plone 3:ssa
    • TYPO3  - käyttämällä af_markdown-laajennusta [48]
    • RadiantCMS  on yksi heti käyttöönotetuista merkintätyypeistä [49]
    • HTMLy - käytetään oletuksena sisällön tallentamiseen (tietokantojen sijaan) [50]
  • Verkkokehykset :
    • Ruby on Rails  - vaatii BlueClothin asennuksen, Maruku [51]
    • Yii  - CMarkdown-widget, sisältyy kehyksen vakiotoimitukseen
    • Webasyst  - sisältyy PHP-kehyksen vakiotoimitukseen lisäosana ilmaiselle Blog-sovellukselle
    • Symfony  - Edellyttää KnpMarkdownBundle-paketin asentamista
  • Sosiaaliset sovellukset:

Tuki tekstieditoreille

Muistiinpanot

  1. ↑ Markdown File Extension  ( 1. elokuuta 2014). Haettu 16. heinäkuuta 2020. Arkistoitu alkuperäisestä 12. heinäkuuta 2020.
  2. ↑ Markdown  . _ Aaron Swartz: The Weblog (19. maaliskuuta 2004). Haettu 16. heinäkuuta 2020. Arkistoitu alkuperäisestä 25. joulukuuta 2019.
  3. ↑ Daring Fireball: Markdown . Haettu 16. heinäkuuta 2020. Arkistoitu alkuperäisestä 15. heinäkuuta 2020.
  4. ↑ Merkintä: Lisenssi . Rohkea Tulipallo. Haettu 16. heinäkuuta 2020. Arkistoitu alkuperäisestä 17. kesäkuuta 2020.
  5. ↑ Leonard S. The text/markdown Media Type  (eng.) - IETF , 2016. - 15 s. doi : 10.17487/RFC7763
  6. ↑ Markdown Syntaksi Kuvaus Arkistoitu 22. helmikuuta 2011 Wayback Machinessa 
  7. ↑ Markdownsharp
  8. ↑ Knagis CommonMark.NET . Haettu 4. heinäkuuta 2018. Arkistoitu alkuperäisestä 11. kesäkuuta 2018.
  9. ↑ Alennus - Markdown-kuvauskielen C-toteutus . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 4. kesäkuuta 2008.
  10. ↑ Standardien mukainen, nopea ja turvallinen merkintöjen käsittelykirjasto C :ssä. Haettu 8. huhtikuuta 2015. Arkistoitu alkuperäisestä 1. elokuuta 2015.
  11. ↑ Markdownin toteutus C:ssä PEG-kieliopin avulla . Haettu 8. huhtikuuta 2015. Arkistoitu alkuperäisestä 23. maaliskuuta 2015.
  12. ↑ Joustava C-kirjasto merkintöjen jäsentämiseen . Haettu 9. huhtikuuta 2015. Arkistoitu alkuperäisestä 20. toukokuuta 2018.
  13. ↑ CFX_Markdown | Seb Duggan (linkki ei saatavilla) . Käyttöpäivä: 29. toukokuuta 2008. Arkistoitu alkuperäisestä 23. marraskuuta 2008. 
  14. ↑ CL-Markdown - Markdown ja paljon muuta . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 16. toukokuuta 2008.
  15. ↑ Blackfriday: Prosessori Golle . Haettu 15. lokakuuta 2013. Arkistoitu alkuperäisestä 20. kesäkuuta 2014.
  16. ↑ 1 2 3 Pandoc - Tietoja pandocista (downlink) . Käyttöpäivä: 29. toukokuuta 2008. Arkistoitu alkuperäisestä 26. elokuuta 2007. 
  17. ↑ myabc/markdownj . GitHub. Käyttöpäivä: 28. tammikuuta 2016. Arkistoitu alkuperäisestä 17. helmikuuta 2016.
  18. ↑ 1 2 dokka--Kotlin Resources . Haettu 29. marraskuuta 2017. Arkistoitu alkuperäisestä 1. joulukuuta 2017.
  19. ↑ Showdown - Markdownin JavaScript-portti . Haettu 10. elokuuta 2012. Arkistoitu alkuperäisestä 21. elokuuta 2013.
  20. ↑ intellij-markdown . GitHub. Haettu 29. marraskuuta 2017. Arkistoitu alkuperäisestä 11. kesäkuuta 2018.
  21. ↑ Kotlinin dokumentaatiomoottori . Haettu 11. elokuuta 2010. Arkistoitu alkuperäisestä 22. kesäkuuta 2013.
  22. ↑ OTSIKKO . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 16. toukokuuta 2008.
  23. ↑ Hakukone, joka toimii osoitteessa InfoWeb.net  (downlink)
  24. ↑ Teksti::Markdown - search.cpan.org
  25. ↑ PHP Markdown . Käyttöpäivä: 29. toukokuuta 2008. Arkistoitu alkuperäisestä 2. kesäkuuta 2008.
  26. ↑ 1 2 Markdown Pythonissa: Yleiskatsaus (downlink) . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 24. toukokuuta 2008. 
  27. ↑ 1 2 python-markdown2 - Project Hosting Google Codessa . Haettu 17. toukokuuta 2018. Arkistoitu alkuperäisestä 11. kesäkuuta 2018.
  28. ↑ BlueCloth arkistoitu 13. kesäkuuta 2008.
  29. ↑ 1 2 Maruku: Markdown-superset-tulkki (downlink) . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 20. kesäkuuta 2008. 
  30. ↑ MarkWrap - Unified Scala wrapper API erilaisille kevyille merkintäsovellusliittymille . Haettu 5. syyskuuta 2011. Arkistoitu alkuperäisestä 27. elokuuta 2011.
  31. ↑ CAIUS-projektissa on puhdas Tcl-paketti Markdownin käsittelyä varten
  32. ↑ MultiMarkdown . Haettu 9. syyskuuta 2012. Arkistoitu alkuperäisestä 4. heinäkuuta 2013.
  33. ↑ Teksti::MultiMarkdown - search.cpan.org
  34. ↑ PHP Markdown Extra . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 22. toukokuuta 2008.
  35. ↑ Markout: Markout (downlink) . Käyttöpäivä: 29. toukokuuta 2008. Arkistoitu alkuperäisestä 23. helmikuuta 2008. 
  36. ↑ Pandoc's markdown vs. standard markdown Arkistoitu 12. toukokuuta 2014 Wayback Machinessa 
  37. ↑ Daring Fireball: Markdown Web Dingus . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 12. kesäkuuta 2008.
  38. ↑ warpedvisions.org :: Markdown-huijauslehti . Haettu 13. lokakuuta 2013. Arkistoitu alkuperäisestä 12. lokakuuta 2013.
  39. ↑ html2text: THE ASCIINATOR (alias html2txt) . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 9. toukokuuta 2008.
  40. ↑ Markdownify: HTML-markdown-muunnin PHP:lle (downlink) . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 5. kesäkuuta 2008. 
  41. ↑ Make.text
  42. ↑ Elementit tai alempi :: Geekery : XML : XHTML-to-Markdown.html . Haettu 29. toukokuuta 2008. Arkistoitu alkuperäisestä 4. kesäkuuta 2008.
  43. ↑ Merkintä Pythonissa: odt2txt Arkistoitu 24. toukokuuta 2008.
  44. ↑ ProgTips "Blogi-arkisto" Word to Markdown -muunnin (downlink) . Käyttöpäivä: 29. toukokuuta 2008. Arkistoitu alkuperäisestä 27. maaliskuuta 2008. 
  45. ↑ Merkintätyökalu . Haettu 11. heinäkuuta 2021. Arkistoitu alkuperäisestä 1. huhtikuuta 2021.
  46. ↑ Markdown-suodatin Drupalille | drupal.org . Haettu 18. marraskuuta 2010. Arkistoitu alkuperäisestä 25. syyskuuta 2010.
  47. ↑ "Markdown editor" -moduuli Magentolle . Haettu 8. marraskuuta 2015. Arkistoitu alkuperäisestä 4. maaliskuuta 2016.
  48. ↑ typo3.org: Arkisto (downlink) . Käyttöpäivä: 29. toukokuuta 2008. Arkistoitu alkuperäisestä 17. marraskuuta 2006. 
  49. ↑ RadiantCMS (downlink) . Haettu 2. maaliskuuta 2021. Arkistoitu alkuperäisestä 4. kesäkuuta 2006. 
  50. ↑ HTML . Haettu 19. syyskuuta 2018. Arkistoitu alkuperäisestä 19. syyskuuta 2018.
  51. ↑ InfoWeb.netissä toimiva hakukone Arkistoitu 8. syyskuuta 2008. tai RDiscount Arkistoitu 27. elokuuta 2010 Wayback Machinessa , joka on BlueClothin kehitystyö
  52. ↑ Markdown Vim Mode | muovinen poika . Haettu 24. marraskuuta 2015. Arkistoitu alkuperäisestä 14. tammikuuta 2016.
  53. ↑ Emacsin merkintätila . Haettu 24. marraskuuta 2015. Arkistoitu alkuperäisestä 30. marraskuuta 2015.
  54. ↑ Ecto, blogieditori Arkistoitu 18. syyskuuta 2009 Wayback Machinessa 
  55. ↑ Markdown-laajennus Eclipse-ympäristöeditorille Arkistoitu 31. joulukuuta 2009.  (Englanti)
  56. ↑ Markdown-laajennus gedit-tekstieditorille Arkistoitu 13. syyskuuta 2009.  (Englanti)
  57. ↑ iA Writer for Mac Arkistoitu 12. tammikuuta 2012.  (Englanti)
  58. ↑ iA Writer: Keskity – sovellukset Google Playssa. . play.google.com. Käyttöpäivä: 18. marraskuuta 2018. Arkistoitu alkuperäisestä 8. huhtikuuta 2019.
  59. ↑ Gregor Santner. Markor . - 04-07-2022
  60. ↑ ReText - Markdown- ja reStructuredText-tekstieditori Arkistoitu 11. marraskuuta 2012.  (Englanti)
  61. ↑ Tekstit - pelkän tekstin monipuolinen editori Arkistoitu 14. lokakuuta 2012 Wayback Machinessa 
  62. ↑ https://typora.io/ Arkistoitu 11. maaliskuuta 2020 Wayback Machine Typoraan - markdown-editori, markdown-lukija.