Yorumlar Markdown

Bir markdown dosyasında yorum saklama sözdizimi nedir, örneğin dosyanın üstündeki CVS $ Id $ açıklaması? Markdown projesinde hiçbir şey bulamadım .

Önceden önerilen tüm çözümlerin (belirli uygulamalar gerektiren çözümlerin dışında), görüntülenmedikleri halde yorumların çıktı HTML'sinde yer almasına neden olduğuna inanıyorum.

Kesinlikle kendiniz için olan bir yorum istiyorsanız (dönüştürülmüş belgenin okuyucuları "görünümü kaynağı" ile bile göremez), (ab) bağlantı etiketlerini çekirdek Markdown spesifikasyonunda mevcuttur:

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

Yani:

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

Veya daha ileri gidebilirsiniz:

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

Platform uyumluluğunu geliştirmek (ve bir tuş vuruşunu kaydetmek) için aşağıdakileri kullanmak da mümkündür #(meşru bir köprü hedefi) <>:

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

Maksimum taşınabilirlik için, bu tür yorumlardan önce ve sonra boş bir satır eklemek önemlidir, çünkü bazı Markdown ayrıştırıcılar tanımlamalar normal metne göre fırçalandığında düzgün çalışmaz. Babelmark ile yapılan en son araştırma, önceki ve sonraki boş satırların her ikisinin de önemli olduğunu göstermektedir. Bazı ayrıştırıcılar daha önce boş satır yoksa yorumu gönderir ve bazı ayrıştırıcılar daha sonra boş satır yoksa aşağıdaki satırı hariç tutar.

Genel olarak, bu yaklaşım temel şartnamenin bir parçası olduğu için çoğu Markdown ayrıştırıcısı ile çalışmalıdır. (birden çok bağlantı tanımlandığında veya bir bağlantı tanımlanmış ancak hiç kullanılmamışsa, davranış kesinlikle belirtilmemiş olsa bile).

Gibi standart HTML etiketleri kullanıyorum

<!---
your comment goes here
and here
-->

Üçlü tireye dikkat edin. Avantajı, TeX veya HTML çıktısı oluştururken pandoc ile çalışmasıdır . Daha fazla bilgi pandoc-tartışma grubunda mevcuttur.

Bu küçük araştırma Magnus'un cevabını kanıtlıyor ve geliştiriyor

Platformdan en bağımsız sözdizimi

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

Her iki koşul da önemlidir:

1. Kullanma #(ve değil <>)
2. Yorumdan önce boş bir satırla . Yorumdan sonraki boş satırın sonuç üzerinde bir etkisi yoktur.

Sıkı Markdown spesifikasyonu CommonMark sadece bu sözdizimiyle (ve <>boş satırla değil)

Bunu kanıtlamak için John MacFarlane tarafından yazılan Babelmark2'yi kullanacağız. Bu araç, 28 Markdown uygulamasında belirli kaynak kodunun oluşturulmasını kontrol eder.

( +- testi geçti, -- geçmedi, ?- işlenmiş HTML'de gösterilmeyen bazı çöpler bırakır).

• <>13+, 15- kullanarak boş satır yok
• Yorumdan önce boş satır,<> 20+, 8-
• Yorumun çevresindeki boş satırlar,<> 20+, 8-
• #13+ 1 kullanan boş satır yok mu? 14-
• Yorumdan önce# 23+ 1 kullanarak satır boş mu? 4-
• #23+ 1 kullanarak yorumun etrafındaki satırlar boş mu? 4-
• 3 kısa çizgi 1+ 2 ile HTML yorumu ? 25- chl'nin cevabından (bunun farklı sözdizimi olduğunu unutmayın)

Bu, yukarıdaki ifadeleri kanıtlamaktadır.

Bu uygulamalar 7 testin hepsinde başarısız olur. Onlarla dışlanan yorumlarda yorum kullanma şansı yoktur.

• cebe / etiketleme 1.1.0
• cebe / markdown MarkdownExtra 1.1.0
• cebe / markdown GFM 1.1.0
• s9e \ TextFormatter (Fatdown / PHP)

Jekyll veya ahtapot kullanıyorsanız aşağıdaki de işe yarayacaktır.

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

Önce Sıvı etiketleri {% comment %}ayrıştırılır ve MarkDown işlemcisi buna ulaşmadan kaldırılır. Ziyaretçiler, tarayıcılarından kaynak görüntülemeye çalıştıklarında görmezler.

Alternatif olarak stilize HTML etiketlerinin içine yorumlar koymak da mümkündür. Bu şekilde, görünürlüklerini gerektiği gibi değiştirebilirsiniz. Örneğin, CSS stil sayfanızda bir yorum sınıfı tanımlayın.

.comment { display: none; }

Ardından, aşağıdaki İŞARETLİ

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

bir TARAYICI'da aşağıdaki gibi görünür

We do support comments

Bu GitHub'da çalışır:

[](Comment text goes here)

Ortaya çıkan HTML şöyle görünür:

<a href="Comment%20text%20goes%20here"></a>

Bu temelde boş bir bağlantıdır. Açıkçası bunu işlenen metnin kaynağında okuyabilirsiniz, ancak yine de GitHub'da yapabilirsiniz.

Vim Instant-Markdown kullanıcılarının kullanması gerekiyor

<!---
First comment line...
//
_NO_BLANK_LINES_ARE_ALLOWED_
//
_and_try_to_avoid_double_minuses_like_this_: --
//
last comment line.
-->

Ayrıca, artan sayıda Markdown aracı tarafından desteklenen Kritik İşaretleme konusuna bakın.

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.

Yorumları değerlendirmeyen, yankısız bir R bloğuna koymaya ne dersiniz? yani

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

Benim için iyi çalışıyor gibi görünüyor.

Açıklama: Eklentiyi yazdım.

Soru belirli bir işaretleme uygulaması belirtmediğinden, yukarıda belirtilen aynı pandoc yorumlama stilini uygulayan python- markdown için Yorumlar Eklentisinden bahsetmek istiyorum .

<!--- ... --> 

Pandoc Markdown'da çalışmaz (Pandoc 1.12.2.1). Yorumlar hala html biçiminde görünüyordu. Aşağıdakiler işe yaradı:

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

Ardından + dipnot uzantısını kullanın. Asla referans alınmayan bir dipnot.

Aşağıdakiler çok iyi çalışıyor

<empty line>
[whatever comment text]::

bu yöntem, oluşturulmuş bağlantı referansı oluşturulmayacağından referans yoluyla bağlantı oluşturmak için sözdiziminden yararlanır , benzer şekilde aşağıdakilerden herhangi biri de oluşturulmayacaktır
[1]: http://example.org

<empty line>
[whatever]::
[whatever]:whatever
[whatever]: :
[whatever]: whatever

Pandoc için, yorumu engellemenin iyi bir yolu , pandoc yazarı tarafından önerildiği gibi bir yaml metablock kullanmaktır . Bu benim ortamda en azından diğer önerilen çözümlerin birçoğu kıyasla yorumların daha düzgün sözdizimi vurgulamasını verdiğini fark etmiş ( vim, vim-pandocve vim-pandoc-syntax).

HTML blok yorumlarını html-satır içi yorumlarla birlikte kullanıyorum, çünkü html yorumları yuvalanamıyor . Ne yazık ki, yaml metablock içinde yorum yapmayı engellemenin bir yolu yoktur , bu nedenle her satırın ayrı ayrı yorumlanması gerekir. Neyse ki, yazılımla sarılmış bir paragrafta yalnızca bir satır olmalıdır.

Benim ~/.vimrc, blok yorumları için özel kısayollar ayarladım:

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

-Key ,olarak kullanıyorum ve sırasıyla bir paragrafı yorumluyorum ve yorumunu kaldırıyorum. Birden fazla paragraf yorumlamak gerekirse, ben bir makro (genellikle ) eşlemek ve çalıştırmak (örneğin ( ).Aynı uncommenting için çalışır.<Leader>,b,vj,bQ<number-of-paragraphs><name-of-macro>3Q

kramdown —Jekyll ve dolayısıyla GitHub Sayfaları için varsayılan olan Ruby tabanlı işaretleme motoru - uzantı sözdizimi aracılığıyla yerleşik yorum desteğine sahiptir :

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

Bu, satır içi yorumlara izin verme avantajına sahiptir, ancak diğer Markdown motorlarına taşınabilir olmanın dezavantajı.

Deneyebilirsin

[](
Your comments go here however you cannot leave
// a blank line so fill blank lines with
//
Something
)

Bunu yapabilirsiniz (YAML bloğu):

~~~
# This is a
# multiline
# comment
...

Sadece lateks çıktı ile denedim, lütfen diğerleri için onaylayın.