Pastabos dėl „Markdown“

Kas yra sintaksė, kaip išsaugoti komentarą žymėjimo faile. CVS $ Id $ komentaras failo viršuje? Neradau nieko apie žymėjimo projektą.

1011
28 янв. rinkinys Betamos sausio 28 d 2011-01-28 03:18 '11 at 3:18 2011-01-28 03:18
@ 14 atsakymų

Manau, kad visi anksčiau pasiūlyti sprendimai (be tų, kuriems reikalingi konkretūs diegimo būdai) lemia tai, jog komentarai yra įtraukti į produkcijos HTML, net jei jie nėra rodomi.

Jei jums reikia komentaro, kuris yra griežtai jums skirtas (konvertuoto dokumento skaitytojai neturėtų matyti, net ir su „peržiūros šaltiniu“), galite (ab) naudoti nuorodų etiketes (naudojamas su nuorodų nuorodomis), kurios yra prieinamos pagrindinėje „Markdown“ specifikacijoje:

http://daringfireball.net/projects/markdown/syntax#link

Tai yra:

 [comment]: <> (This is a comment, it will not be included) [comment]: <> (in the output file unless you use it in) [comment]: <> (a reference style link.) 

Arba galite eiti toliau:

 [//]: <> (This is also a comment.) 

Norėdami pagerinti platformos suderinamumą (ir išsaugoti vieną klavišą), galite naudoti # (kuris yra teisėtas hipersaito tikslas) vietoj <> :

 [//]: # (This may be the most platform independent comment) 

Siekiant maksimalaus perkeliamumo, svarbu, kad prieš ir po tokio tipo komentarų būtų įdėta tuščia eilutė, nes kai kurie žymėjimo žymekliai žymekliai nesieja apibrėžimų, kurie išvalo paprastą tekstą. Naujausias Babelmarko tyrimas rodo, kad tuščios eilutės prieš ir po to yra svarbios. Kai kurie analizatoriai parodys komentarą, jei prieš jį nėra tuščios eilutės, o kai kurie parašai pašalins kitą eilutę, jei po jos nėra tuščios eilutės.

Apskritai, šis metodas turėtų būti taikomas daugeliui „Markdown“ analizatorių, nes tai yra pagrindinės specifikacijos dalis. (net jei elgesys, kai apibrėžiamos kelios nuorodos arba kai nuoroda yra apibrėžta, bet niekada nenaudojama, nėra griežtai nurodyta).

1047
02 янв. atsakymas duotas Magnus 02 Jan 2014-01-02 18:18 '14, 18:18, 2014-01-02 18:18

Pavyzdžiui, naudoju standartines HTML žymes

 <!--- your comment goes here and here --> 
border=0

Atkreipkite dėmesį į trigubą brūkšnį. Privalumas yra tas, kad jis veikia su pandoc, kai generuoja TeX arba HTML išvestį. Papildoma informacija pateikiama „ pandoc“ diskusijų grupėje .

807
28 янв. atsakymas pateikiamas sausio 28 d 2011-01-28 18:36 '11, 18:36, 2011-01-28 18:36

Šis mažas tyrimas įrodo ir tobulina Magnus atsakymą.

Dauguma platformų nepriklausoma sintaksė

 (empty line) [comment]: # (This actually is the most platform independent comment) 

Abi sąlygos yra svarbios:

  1. Naudojant # (ne <> )
  2. Prieš komentarą yra tuščia eilutė . Po komentaro tuščia eilutė neturi įtakos rezultatui.

Markdown CommonMark“ griežta specifikacija veikia tik su šia sintakse (o ne su <> ir / arba tuščia eilute)

Norėdami tai įrodyti, naudosime Babelmark2, kurį parašė John MacFarlane. Šis įrankis tikrina, ar nėra 28 „Markdown“ diegimų.

( + - išlaikė testą, - - nepavyko ? - palieka šiukšliadėžę, kuri nerodoma pateiktame HTML).

Tai įrodo pirmiau minėtus teiginius.

Šie įgyvendinimai nesuteikia visų 7 bandymų. Negalima naudoti komentarų su pateiktomis pastabomis.

  • cebe / markdown 1.1.0
  • cebe / markdown MarkdownExtra 1.1.0
  • cebe / markdown GFM 1.1.0
  • TextFormatter (Fatdown / PHP)
129
24 авг. Nick Volynkin atsakymas 24 d. 2015-08-24 22:17 '15 , 10:17 pm 2015-08-24 22:17

Jei naudojate „Jekyll“ ar „Octopress“, taip pat veiks ir toliau.

 {% comment %} These commments will not include inside the source. {% endcomment %} 

Skysčių žymės {% comment %} pirmą kartą analizuojamos ir pašalinamos, kol „MarkDown“ procesorius pasiekia jį. Lankytojai nematys, kada bandys peržiūrėti šaltinį iš savo naršyklės.

43
05 апр. Atsakymas pateikiamas uiroshan 05 balandžio. 2014-04-05 05:57 '14, 5:57 2014-04-05 05:57

Alternatyva yra pateikti komentarus stiliaus HTML žymose. Tokiu būdu galite pakeisti jų matomumą, kaip reikia. Pavyzdžiui, CSS stiliaus lape nustatykite komentarų klasę.

.comment { display: none; }

Tada kitas išplėstas MARKDOWN

We do <span class="comment">NOT</span> support comments

tai atrodo kaip brosser

We do support comments

32
22 февр. Atsakymas pateikiamas Stu vasario 22 d 2011-02-22 21:11 '11, 21:11, 2011-02-22 21:11

Jis veikia „github“:

 <a href="Comment text goes here"> 

Tai tuščia nuoroda. Akivaizdu, kad galite jį perskaityti šaltinio kode, tačiau jūs galite tai padaryti GitHub.

27
19 апр. jomo atsakymas, pateiktas 19 d 2015-04-19 03:19 '15 at 3:19 2015-04-19 03:19

Taip pat žiūrėkite skyrių „Kritikų žymėjimas“, kurį palaiko vis daugiau „Markdown“ įrankių.

http://criticmarkup.com/

 Comment {>> <<} Lorem ipsum dolor sit amet.{>>This is a comment<<} Highlight+Comment {== ==}{>> <<} Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus. 
15
31 марта '14 в 14:17 2014-03-31 14:17 atsakymą pateikė Kerim , kovo 31 d. 14:17 2014-03-31 14:17

Kaip apie komentarų skelbimą ne eval, ne echo R bloke? tai yra,

 ```{r echo=FALSE, eval=FALSE} All the comments! ``` 

Man atrodo, kad tai gerai veikia.

11
23 нояб. David Kaufman atsakymas lapkričio 23 d 2015-11-23 06:19 '15 at 6:19 2015-11-23 06:19

Atskleidimas: parašiau papildinį.

Kadangi klausime nenurodytas konkretus „downdown“ įgyvendinimas, norėčiau paminėti komentarąpython-markdown“ papildinį , kuris įgyvendina tą patį pirmiau minėtą pandoc komentarų stilių.

10
22 авг. Atsakymas, kurį pateikė Ryne Everett rugpjūčio 22 d 2013-08-22 13:00 '13 13:00 val. 2013-08-22 13:00

Vim Instant-Markdown vartotojai turi naudoti

 <!--- First comment line... // _NO_BLANK_LINES_ARE_ALLOWED_ // _and_try_to_avoid_double_minuses_like_this_: -- // last comment line. --> 
9
01 нояб. atsakymas pateikiamas alex 01 lapkričio. 2016-11-01 21:47 '16 at 9:47 pm 2016-11-01 21:47
 <!--- ... --> 

Neveikia Pandoc Markdown (Pandoc 1.12.2.1). Komentarai vis dar pasirodė html. Atlikta:

 Blank line [^Comment]: Text that will not appear in html source Blank line 

Tada naudokite pratęsimą + išnašą. Iš esmės tai yra išnaša, kuri niekada nėra nurodyta.

9
23 февр. Atsakymas pateikiamas Brad Porter 23 vasario mėn. 2016-02-23 19:13 '16, 19:13, 2016-02-23 19:13

Pandoc atveju geras būdas užblokuoti komentarą yra naudoti „yaml“ metablock, kaip pasiūlė „pandoc“ autorius . Pastebėjau, kad jis suteikia teisingesnį komentarų sintaksę nei daugelis kitų siūlomų sprendimų, bent jau mano aplinkoje ( vim , vim-pandoc ir vim-pandoc-syntax ).

Naudoju yaml blokų komentarus kartu su html-inline komentarais, nes html komentarai negali būti įterpti . Deja, blokų komentaruose nėra komentarų , todėl kiekviena eilutė turi būti atskirai atskirta. Laimei, vienoje eilutėje turėtų būti tik viena eilutė.

Mano ~/.vimrc nustatysiu blokinių komentarų pasirinktines etiketes:

 nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down> nmap <Leader>v {jddx}kdd 

Aš naudoju savo <Leader> klavišą, taigi ,b ir ,v komentarą ir atsiųskite pastraipą. Jei man reikia komentuoti keletą punktų, žemėlapis j,b makrokomandoje (paprastai Q ) ir paleiskite <number-of-paragraphs><name-of-macro> 3Q <number-of-paragraphs><name-of-macro> (pvz., ( 3Q )). Tie patys darbai atliekami skiltyje.

5
18 марта '16 в 18:26 2016-03-18 18:26 joelostblom atsakymas kovo 18, 16 d. 18:26 2016-03-18 18:26

„kramdown“ - „Ruby“ pagrįstas žymėjimo variklis, kuris pagal nutylėjimą yra „Jekyll“, todėl „GitHub Pages“ - turi pastabų palaikymą pastabų sintaksėje :

 {::comment} This text is completely ignored by kramdown - a comment in the text. {:/comment} Do you see {::comment}this text{:/comment}? {::comment}some other comment{:/} 

Tai leidžia naudoti inline komentarus, tačiau trūkumas yra tas, kad jie nėra nešiojamieji kitiems Markdown įrenginiams.

5
19 февр. atsakymas pateikiamas vossad01 19 vas. 2017-02-19 06:42 '17, 6:42 2017-02-19 06:42

Galite pabandyti

 []( Your comments go here however you cannot leave // a blank line so fill blank lines with // Something ) 
4
01 февр. Atsakymas pateikiamas magagai 01 vasario mėn. 2016-02-01 04:15 '16 at 4:15 am 2016-02-01 04:15

Kiti klausimai apie ženklų arba Užduoti klausimą