Komentari na Markdown

Na primjer, koja je sintaksa za pohranjivanje komentara u datoteci za smanjenje. CVS $ Id $ komentar na vrhu datoteke? Nisam pronašao ništa u projektu smanjivanja .

1011
28 янв. set Betamos 28. sij 2011-01-28 03:18 '11 u 3:18 2011-01-28 03:18
@ 14 odgovora

Vjerujem da sva prethodno predložena rješenja (osim onih koja zahtijevaju specifične implementacije) dovode do činjenice da su komentari uključeni u izlazni HTML, čak i ako nisu prikazani.

Ako vam je potreban komentar koji je isključivo za vas (čitatelji pretvorenog dokumenta ne bi ga trebali vidjeti, čak ni s "izvorom pogleda"), možete (ab) koristiti oznake veza (za upotrebu s referencama veza) koje su dostupne u osnovnoj Markdown specifikaciji

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

To je:

 [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.) 

Ili možete ići dalje:

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

Da biste poboljšali kompatibilnost platforme (i spremili jedan pritisak na tipku), možete koristiti i # (što je legitimna meta hiperveze) umjesto <> :

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

Za maksimalnu prenosivost, važno je umetnuti prazan redak prije i poslije ove vrste komentara, jer neki Markdown markeri ne vežu definicije koje brišu običan tekst. Najnovija Babelmarkova studija pokazuje da su prazne linije prije i poslije važne. Neki parseri će prikazati komentar ako ispred njega nema praznog retka, a neki parseri će isključiti sljedeći redak ako iza njega nema praznog retka.

Općenito, ovaj pristup bi trebao raditi s većinom Markdown parsera, jer je dio glavne specifikacije. (čak i ako je ponašanje, kada je definirano nekoliko veza, ili kada je veza definirana, ali nikad korištena, nije strogo određena).

1047
02 янв. odgovor je dan Magnus 02 Jan 2014-01-02 18:18 '14 u 18:18 2014-01-02 18:18

Primjerice, koristim standardne HTML oznake

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

Obratite pozornost na trostruku crticu. Prednost je što radi s pandocom prilikom generiranja TeX ili HTML izlaza. Dodatne informacije dostupne su u grupi pandoc-discuss .

807
28 янв. odgovor je dan 28. siječnja 2011-01-28 18:36 '11 u 18:36 2011-01-28 18:36

Ova mala studija dokazuje i oplemenjuje Magnusov odgovor.

Sintaksa neovisna o platformi

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

Oba uvjeta su važna:

  1. Korištenje # (ne <> )
  2. S praznim retkom prije komentara . Prazan redak nakon komentara ne utječe na rezultat.

Stroga specifikacija Markdown CommonMark funkcionira samo s ovom sintaksom (a ne s <> i / ili praznim nizom)

Da bismo to dokazali, koristit ćemo Babelmark2, koji je napisao John MacFarlane. Ovaj alat provjerava prikazivanje određenog izvornog koda u 28 Markdown implementacija.

( + - prošao test, - - nije prošao ? - ostavlja smeće koje nije prikazano u prikazanom HTML-u).

To dokazuje gore navedene tvrdnje.

Ove implementacije ne daju svih 7 testova. Nema mogućnosti korištenja komentara s uključenim komentarima.

  • cebe / markdown 1.1.0
  • cebe / markdown MarkdownExtra 1.1.0
  • cebe / markdown GFM 1.1.0
  • Oblikovanje teksta (Fatdown / PHP)
129
24 авг. odgovor dao Volkovkin Nick 24 aug. 2015-08-24 22:17 '15 u 22:17 sati 2015-08-24 22:17

Ako koristite Jekyll ili Octopress, sljedeće će također raditi.

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

Tekuće oznake {% comment %} prvo se analiziraju i uklanjaju prije nego što procesor MarkDown dođe do njega. Posjetitelji neće vidjeti kada pokušaju pogledati izvor iz svog preglednika.

43
05 апр. Odgovor je dat uiroshan 05 apr. 2014-04-05 05:57 '14 u 5:57 2014-04-05 05:57

Alternativa je postavljanje komentara u stiliziranim HTML oznakama. Na taj način možete promjeniti njihovu vidljivost prema potrebi. Na primjer, definirajte klasu komentara u CSS-ovom listu stilova.

.comment { display: none; }

Zatim sljedeći prošireni MARKDOWN

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

izgleda ovako u brosseru

We do support comments

32
22 февр. Odgovor je dat Stu 22. veljače 2011-02-22 21:11 '11 u 21:11 2011-02-22 21:11

Radi na githubu:

 <a href="Comment text goes here"> 

Ovo je prazna veza. Očito, možete ga pročitati u izvornom kodu, ali to možete učiniti na GitHubu.

27
19 апр. odgovor od jomo 19. travnja 2015-04-19 03:19 '15 u 3:19 2015-04-19 03:19

Također pogledajte odjeljak Critic Markup, koji podržava sve veći broj Markdown alata.

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 odgovor je dao Kerim 31. ožujka 2014. u 14:17 2014-03-31 14:17

Kako o objavljivanju komentara u non-eval, non-echo R bloku? to jest,

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

Čini se da dobro funkcionira za mene.

11
23 нояб. Odgovor Davida Kaufmana 23. studenog 2015-11-23 06:19 '15 u 6:19 2015-11-23 06:19

Objavljivanje: Napisao sam dodatak.

Budući da pitanje ne ukazuje na specifičnu implementaciju markdown-a, želio bih spomenuti dodatak za komentare za python-markdown , koji implementira isti stil pandoc komentara spomenutog gore.

10
22 авг. Odgovor dat Ryne Everett 22. \ T 2013-08-22 13:00 '13 u 13:00 2013-08-22 13:00

Vim Instant-Markdown korisnici trebaju koristiti

 <!--- First comment line... // _NO_BLANK_LINES_ARE_ALLOWED_ // _and_try_to_avoid_double_minuses_like_this_: -- // last comment line. --> 
9
01 нояб. odgovor je dao alex 01. studenog. 2016-11-01 21:47 '16 u 21:47 2016-11-01 21:47
 <!--- ... --> 

Ne radi u Pandoc Markdown (Pandoc 1.12.2.1). Komentari se još uvijek pojavljuju u html-u. Sljedeće je učinjeno:

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

Zatim upotrijebite proširenje + fusnotu. To je, u biti, fusnota koja se nikada ne spominje.

9
23 февр. Odgovor je dat Bradu Porteru 23. veljače. 2016-02-23 19:13 '16 u 19:13 2016-02-23 19:13

Za pandoc, dobar način blokiranja komentara jest upotreba yaml metabloka, kao što je predložio pandoc autor . Primijetio sam da daje točnije sintaksno naglašavanje komentara od mnogih drugih predloženih rješenja, barem u mom okruženju ( vim , vim-pandoc i vim-pandoc-syntax ).

Koristim komentare bloka yaml u kombinaciji s komentarima u HTML-u, jer html komentari ne mogu biti ugniježđeni . Nažalost, nema komentara u bloku koji komentira u bloku razmjene jabuka , tako da svaki redak mora biti komentiran zasebno. Srećom, u paragrafu s mekim omotom trebao bi postojati samo jedan redak.

U mom ~/.vimrc postavljam prilagođene oznake za komentare bloka:

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

Koristim tipku <Leader> , dakle ,b i ,v komentar i unkommentira paragraf. Ako trebam komentirati nekoliko paragrafa, mapu j,b na makro (obično Q ) i pokrenite <number-of-paragraphs><name-of-macro> (na primjer, ( 3Q )). Isto vrijedi i za podjelu.

5
18 марта '16 в 18:26 2016-03-18 18:26 odgovor dao joelostblom 18. ožujka '16 u 18:26 2016-03-18 18:26

kramdown - mehanizam za označavanje temeljen na Rubyu koji se postavlja na Jekyll i stoga GitHub Pages - ima ugrađenu podršku za komentare kroz sintaksu proširenja :

 {::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{:/} 

To omogućuje korištenje ugradbenih komentara, ali nedostatak je u tome što nisu prenosivi na druge Markdown uređaje.

5
19 февр. odgovor je dat vossad01 19. veljače. 2017-02-19 06:42 '17 u 6:42 2017-02-19 06:42

Možete pokušati

 []( Your comments go here however you cannot leave // a blank line so fill blank lines with // Something ) 
4
01 февр. Odgovor je dat magaga 01. veljače. 2016-02-01 04:15 '16 u 4:15 am 2016-02-01 04:15

Ostala pitanja o odbijanju ili postavljanju pitanja