syntax मार्कडाउन में टिप्पणियाँ




comments markdown (12)

एक मार्कडाउन फ़ाइल में टिप्पणी संग्रहीत करने के लिए वाक्यविन्यास क्या है, उदाहरण के लिए फ़ाइल के शीर्ष पर एक सीवीएस $ आईडी $ टिप्पणी? मुझे मार्कडाउन प्रोजेक्ट पर कुछ भी नहीं मिला।


पैंडोक के लिए, पांडोक लेखक द्वारा सुझाए गए अनुसार, यम मेटलॉकॉक का उपयोग करने के लिए टिप्पणी को अवरुद्ध करने का एक अच्छा तरीका है। मैंने देखा है कि कम से कम मेरे पर्यावरण ( vim , vim-pandoc , और vim-pandoc-syntax ) में, अन्य प्रस्तावित समाधानों की तुलना में टिप्पणियों की अधिक उचित वाक्यविन्यास हाइलाइटिंग प्रदान करता है।

मैं एचटीएमएल-इनलाइन टिप्पणियों के साथ संयोजन में यामल ब्लॉक टिप्पणियों का उपयोग करता हूं, क्योंकि एचटीएमएल-टिप्पणियों को घोंसला नहीं दिया जा सकता है । दुर्भाग्यवश, यमल मेटाबॉक के भीतर टिप्पणी अवरुद्ध करने का कोई तरीका नहीं है , इसलिए प्रत्येक पंक्ति को अलग-अलग टिप्पणी की जानी चाहिए। सौभाग्य से, मुलायम अनुच्छेद में केवल एक पंक्ति होनी चाहिए।

मेरे ~/.vimrc , मैंने ब्लॉक टिप्पणियों के लिए कस्टम शॉर्टकट सेट अप किए हैं:

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

मैं अपने <Leader> -की, इसलिए ,b और ,v टिप्पणी और अनुच्छेद क्रमशः अनुच्छेद के रूप में उपयोग करता हूं। अगर मुझे एकाधिक पैराग्राफ पर टिप्पणी करने की ज़रूरत है, तो मैं j,b को मैक्रो (आमतौर पर Q ) में मैप करता हूं और <number-of-paragraphs><name-of-macro> (उदाहरण के लिए ( 3Q ) चलाता हूं। यह असम्बद्धता के लिए समान कार्य करता है।


यदि आप जैकिल या ऑक्टोप्रेस का उपयोग कर रहे हैं तो भी काम करेगा।

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

लिक्विड टैग {% comment %} को पहले पार्स किया गया है और मार्कडाउन प्रोसेसर से पहले भी हटा दिया गया है। आगंतुक तब नहीं देख पाएंगे जब वे अपने ब्राउज़र से स्रोत देखने का प्रयास करेंगे।


तुम कोशिश कर सकते हो

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

स्टाइलिज्ड एचटीएमएल टैग के भीतर टिप्पणियां डालने का एक विकल्प है। इस तरह, आप अपनी दृश्यता को आवश्यकतानुसार टॉगल कर सकते हैं। उदाहरण के लिए, अपने सीएसएस स्टाइलशीट में एक टिप्पणी कक्षा परिभाषित करें।

.comment { display: none; }

फिर, निम्नलिखित बढ़ाया मार्कडाउन

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

ब्रॉसर में निम्नानुसार दिखाई देता है

We do support comments


kramdown रुबी-आधारित kramdown इंजन जो kramdown लिए डिफ़ॉल्ट है और इस प्रकार kramdown ने अपने विस्तार वाक्यविन्यास के माध्यम से अंतर्निहित टिप्पणी का समर्थन किया है :

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

इन-लाइन टिप्पणियों की अनुमति देने का लाभ है, लेकिन अन्य मार्कडाउन इंजनों के लिए पोर्टेबल नहीं होने का नकारात्मक पक्ष है।


मैं मानक एचटीएमएल टैग का उपयोग करता हूं, जैसे

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

ट्रिपल डैश नोट करें। लाभ यह है कि यह टीएक्स या एचटीएमएल आउटपुट उत्पन्न करते समय pandoc साथ काम करता है। अधिक जानकारी pandoc-discuss समूह पर उपलब्ध है।


<!--- ... --> 

पांडोक मार्कडाउन (पांडोक 1.12.2.1) में काम नहीं करता है। टिप्पणियां अभी भी एचटीएमएल में दिखाई दीं। निम्नलिखित काम किया:

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

फिर + फुटनोट एक्सटेंशन का उपयोग करें। यह अनिवार्य रूप से एक फुटनोट है जिसे कभी संदर्भित नहीं किया जाता है।


यह गिटहब पर काम करता है:

[](Comment text goes here)

परिणामी एचटीएमएल इस तरह दिखता है:

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

जो मूल रूप से एक खाली लिंक है। जाहिर है आप इसे प्रस्तुत पाठ के स्रोत में पढ़ सकते हैं, लेकिन आप इसे गिटहब पर भी कर सकते हैं।


गैर-eval, गैर-गूंज आर ब्लॉक में टिप्पणियां डालने के बारे में कैसे? अर्थात,

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

मेरे लिए अच्छा काम करने लगता है।


विम Instant-Markdown उपयोगकर्ताओं को उपयोग करने की आवश्यकता है

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

प्रकटीकरण: मैंने प्लगइन लिखा था।

चूंकि प्रश्न एक विशिष्ट मार्कडाउन कार्यान्वयन निर्दिष्ट नहीं करता है, इसलिए मैं python-markdown मार्कडाउन के लिए टिप्पणियां प्लगइन का उल्लेख करना चाहता हूं, जो उपरोक्त वर्णित एक ही पैंडोक टिप्पणी शैली लागू करता है।


मेरा मानना ​​है कि सभी पहले प्रस्तावित समाधान (उन लोगों के अलावा जिन्हें विशिष्ट कार्यान्वयन की आवश्यकता होती है) परिणामस्वरूप एचटीएमएल आउटपुट में शामिल किया जा रहा है, भले ही वे प्रदर्शित न हों।

यदि आप एक टिप्पणी चाहते हैं जो सख्ती से आपके लिए है (परिवर्तित दस्तावेज़ के पाठक इसे "स्रोत देखें" के साथ भी देख नहीं पाएंगे) तो आप लिंक लेबल (संदर्भ शैली लिंक के साथ उपयोग के लिए) का उपयोग कर सकते हैं कोर मार्कडाउन विनिर्देश में उपलब्ध है:

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

अर्थात्:

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

या आप आगे जा सकते हैं:

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

प्लेटफार्म संगतता में सुधार करने के लिए (और एक कीस्ट्रोक को सहेजने के लिए) <> बजाय # (जो वैध हाइपरलिंक लक्ष्य है) का उपयोग करना भी संभव है।

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

अधिकतम पोर्टेबिलिटी के लिए इस प्रकार की टिप्पणियों से पहले और बाद में एक खाली रेखा डालना महत्वपूर्ण है, क्योंकि कुछ मार्कडाउन पार्सर्स नियमित पाठ के खिलाफ ब्रशिंग परिभाषाओं को लिंक नहीं करते हैं। बेबेलमार्क के साथ हालिया शोध से पता चलता है कि पहले और बाद में रिक्त रेखाएं दोनों महत्वपूर्ण हैं। अगर कुछ खाली रेखा नहीं है तो कुछ पार्सर्स टिप्पणी आउटपुट करेंगे, और कुछ पार्सर्स निम्न पंक्ति को बाहर कर देंगे यदि कोई रिक्त रेखा नहीं है।

आम तौर पर, इस दृष्टिकोण को अधिकांश मार्कडाउन पार्सर्स के साथ काम करना चाहिए, क्योंकि यह मूल विनिर्देश का हिस्सा है। (भले ही व्यवहार कई लिंक परिभाषित किए जाते हैं, या जब एक लिंक परिभाषित किया जाता है लेकिन कभी भी उपयोग नहीं किया जाता है, तो सख्ती से निर्दिष्ट नहीं किया जाता है)।





markdown