মার্কডাউন-এ মন্তব্যগুলি


1398

মার্কডাউন ফাইলে মন্তব্য সংরক্ষণ করার সিনট্যাক্স কী, যেমন ফাইলের শীর্ষে সিভিএস $ আইডি $ মন্তব্য? মার্কডাউন প্রকল্পে আমি কিছুই পাইনি ।


10
লাইনের মধ্যে পড়া, মনে হচ্ছে আপনি আপনার মার্কডাউনে মেটাডেটা সংযুক্ত করতে চান। সেই কারণে, আমি একটি প্রিপ্রসেসর ব্যবহার করার পরামর্শ দেব যা আপনাকে একটি শিরোনাম যুক্ত করতে দেয়। একটি উদাহরণের জন্য, জেকিলের সামনের বিষয়টি দেখুন । অন্য উদাহরণের জন্য দেখুন কীভাবে বাশো মিডলম্যানকে তাদের ডকুমেন্টেশনের জন্য ব্যবহার করে । (দ্রষ্টব্য: এটি প্রশ্নের সরাসরি উত্তর নয়, এ কারণেই আমি এটি একটি মন্তব্য হিসাবে ভাগ করছি))
ডেভিড জে


বাবেলমার্কে বিভিন্ন পার্সার সহ বিভিন্ন মন্তব্য টাইপের একটি মাপদণ্ড এখানে ।
ইউলিস বিএন

উত্তর:


1451

আমি বিশ্বাস করি যে পূর্ববর্তী সমস্ত প্রস্তাবিত সমাধানগুলি (নির্দিষ্ট প্রয়োগগুলির প্রয়োজন ব্যতীত) ফলাফলগুলি প্রদর্শিত না হলেও, ফলাফলগুলি আউটপুট এইচটিএমএলে অন্তর্ভুক্ত করার ফলস্বরূপ।

যদি আপনি নিজের মতামত কঠোরভাবে একটি মন্তব্য চান (রূপান্তরিত দস্তাবেজটির পাঠকরা এটি দেখতে সক্ষম হবেন না, এমনকি "উত্স দেখুন" দিয়েও) আপনি লিঙ্ক লেবেলগুলি (রেফারেন্স স্টাইলের লিঙ্কগুলির সাথে ব্যবহারের জন্য) ব্যবহার করতে পারেন যা মূল মার্কডাউন নির্দিষ্টকরণে উপলব্ধ:

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)

সর্বাধিক বহনযোগ্যতার জন্য এই ধরণের মন্তব্যের আগে এবং পরে একটি ফাঁকা লাইন সন্নিবেশ করা গুরুত্বপূর্ণ, কারণ সংজ্ঞাগুলি নিয়মিত পাঠ্যের বিরুদ্ধে ব্রাশ করলে কিছু মার্কডাউন পার্সার সঠিকভাবে কাজ করে না। ব্যাবেলমার্কের সাথে সাম্প্রতিক গবেষণাটি দেখায় যে আগে এবং পরে ফাঁকা রেখা দুটিই গুরুত্বপূর্ণ। কিছু পার্সার আগে ফাঁকা রেখা না থাকলে মন্তব্যটি আউটপুট দেবে এবং কিছু পার্সার যদি ফাঁকা রেখা না থাকে তবে নিম্নলিখিত লাইনটি বাদ দেবে।

সাধারণভাবে, এই পদ্ধতির বেশিরভাগ মার্কডাউন পার্সারদের সাথে কাজ করা উচিত, কারণ এটি মূল স্পেসিফিকেশনের অংশ। (এমনকি যদি একাধিক লিঙ্ক সংজ্ঞায়িত করা হয়, বা যখন কোনও লিঙ্ক সংজ্ঞায়িত করা হয় তবে কখনই ব্যবহৃত হয় না, তবে কঠোরভাবে নির্দিষ্ট করা হয় না)।


145
[//]: # "Comment"এবং [//]: # (Comment)প্রয়োগের বিভিন্ন ধরণের কাজ করে বলে মনে হচ্ছে, কারণ #এটি একটি বৈধ আপেক্ষিক ইউআরআই। উদাহরণস্বরূপ, গিটহাব প্রত্যাখ্যান করে <>এবং পুরো লাইনটি দৃশ্যমান হয়। এটি লক্ষণীয় যে লিংক লেবেলগুলি প্রায়শই একটি খালি রেখার দ্বারা অন্য সামগ্রী থেকে পৃথক হওয়া প্রয়োজন।
জেনেক্সার 0

6
বেশিরভাগ প্ল্যাটফর্ম-স্বতন্ত্র হওয়ার জন্য এটির মন্তব্যের আগে খালি লাইনও দরকার। : পরীক্ষার দেখুন stackoverflow.com/a/32190021/2790048
নিক Volynkin

6
এটি কি বহুজাতিক মন্তব্যের জন্য ব্যবহার করা যেতে পারে?
ক্রিপডিক

4
@ রোভিংরিচার্ড হ্যাঁ, কমেন্টে ব্লকটিতে কোনও ফাঁকা রেখা না থাকলে কমপক্ষে প্যান্ডোকে এটি মাল্টলাইন মন্তব্যগুলির জন্য কাজ করে (একক লাইন বিরতি ঠিক আছে)। আমি ব্লক মন্তব্যগুলির জন্য ম্যাগনাসের পদ্ধতির এবং ইনলাইন মন্তব্যের জন্য chl এর এইচটিএমএল পদ্ধতির ব্যবহার করি (যদিও সাধারণত মাত্র 2 টি ড্যাশ থাকে)। এইভাবে আমি ইতিমধ্যে ইনলাইন এইচটিএমএল মন্তব্যযুক্ত অনুচ্ছেদে মন্তব্যগুলি আটকে দিতে পারি।
joelostblom

4
শুধু এফওয়াইআই, তবে আপনি যদি প্যান্ডোক ব্যবহার করে একটি টিওসি তৈরি করে থাকেন তবে এটি সদৃশ লিঙ্কের উল্লেখগুলি সম্পর্কে সতর্কতা তৈরি করবে। (এটি কেবলমাত্র সতর্কতা,
টিওসিটি

995

আমি স্ট্যান্ডার্ড এইচটিএমএল ট্যাগগুলি ব্যবহার করি

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

ট্রিপল ড্যাশ নোট করুন। সুবিধাটি হ'ল এটি প্যান্ডোকের সাথে টেক্স বা এইচটিএমএল আউটপুট তৈরি করার সময় কাজ করে। পান্ডোক-আলোচনা গোষ্ঠীতে আরও তথ্য উপলব্ধ ।


73
যদি আমি সঠিকভাবে বুঝতে পারি তবে ট্রিপল ড্যাশটি মার্কডাউন ফাইলটিকে পার্স করার সময় প্যানডোক মন্তব্যটিকে উপেক্ষা করে। তবে আপনি যদি অন্য মার্কডাউন ইঞ্জিন ব্যবহার করেন তবে মন্তব্যটি উত্পন্ন এইচটিএমএলে প্রদর্শিত হবে (এবং এইভাবে "উত্স উত্স" এর সাথে দৃশ্যমান হবে)। সুতরাং আপনাকে সেই মন্তব্যে কী দেওয়া হয়েছে সে সম্পর্কে আপনাকে সতর্কতা অবলম্বন করতে হবে;)
সিবারজান

5
আপনি কী ব্যাখ্যা করতে পারেন যে কীভাবে প্যান্ডোক ট্রিপল ড্যাশগুলি দ্বৈত একের চেয়ে আলাদা আচরণ করে? আমি যখন তাদের সাথে পরীক্ষা-নিরীক্ষা করেছি, তখন তাদের একইভাবে আচরণ করা হয়েছিল বলে মনে হয়েছিল। এছাড়াও, প্যান্ডোক ব্যবহারকারীর গাইডটি কেবল বলেছে "কাঁচা এইচটিএমএলটি এইচটিএমএল, এস 5, স্লাইডি, স্লাইডাস, ডিজেডস্লাইডস, ইপিইউবি, মার্কডাউন এবং টেক্সটাইল আউটপুটগুলিতে অপরিবর্তিত হয়ে অন্য ফর্ম্যাটে দমন করা হবে" " ট্রিপল ড্যাশগুলিতে দ্বিগুণগুলির চেয়ে কোনও বড় সুবিধা রয়েছে বলে মনে হয় না।
dkim

1
ট্রিপল ড্যাশ সহ @ ডিকিম মন্তব্যগুলি এড়িয়ে যাওয়া এবং এইচটিএমএল আউটপুট থেকে বাতিল করা হয়। এইচটিএমএল ফাইলটিতে doubleোকানো ডাবল-ড্যাশযুক্ত মন্তব্যে এমনটি হয় না। প্যান্ডোক (1.10) এর সর্বশেষ সংস্করণে এখনও এটিই রয়েছে।
chl

32
ট্রিপল ড্যাশটি যদি তাৎপর্যপূর্ণ হয় তবে এগুলি "স্ট্যান্ডার্ড এইচটিএমএল" মন্তব্য নয়।
ট্রিপলি

17
গুগলারের জন্য দ্রষ্টব্য: দুর্ভাগ্যক্রমে এটি গিটহাব মার্কডাউনে কাজ করে না এবং আমি ম্যাগনাসের সমাধানটি ব্যবহার করে শেষ করেছি।
ড্যানিয়েল বাকমাস্টার

197

এই ছোট গবেষণাটি ম্যাগনাসের উত্তরটিকে প্রমাণিত করে এবং পরিমার্জন করে

সর্বাধিক প্ল্যাটফর্ম-স্বতন্ত্র সিনট্যাক্স

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

উভয় শর্ত গুরুত্বপূর্ণ:

  1. ব্যবহার #(এবং না <>)
  2. মন্তব্যের আগে খালি লাইন দিয়ে । মন্তব্যের পরে খালি রেখার ফলাফলের কোনও প্রভাব নেই।

কড়া মার্কডাউন স্পেসিফিকেশন কমনমার্ক কেবল এই সিনট্যাক্সের সাথে লক্ষ্য হিসাবে কাজ করে (এবং <>এবং / অথবা একটি ফাঁকা লাইনের সাথে নয়)

এটি প্রমাণ করার জন্য আমরা জন ম্যাকফার্লেন দ্বারা লিখিত বাবেলমার্ক 2 ব্যবহার করব। এই সরঞ্জামটি 28 মার্কডাউন বাস্তবায়নে নির্দিষ্ট উত্স কোডের রেন্ডারিং পরীক্ষা করে।

( +- পরীক্ষাটি -পাস করেছে, ?- পাস করেনি , - এমন কিছু আবর্জনা ফেলেছে যা রেন্ডার এইচটিএমএলে প্রদর্শিত হয়নি)।

এটি উপরের বিবৃতিগুলি প্রমাণ করে।

এই বাস্তবায়নগুলি সমস্ত 7 টি পরীক্ষায় ব্যর্থ হয়। তাদের সাথে বাদ-অন-রেন্ডার মন্তব্যগুলি ব্যবহার করার কোনও সুযোগ নেই।

  • সিবে / মার্কডাউন 1.1.0
  • সিবে / মার্কডাউন মার্কডাউনএক্সট্রা ১.১.০
  • সিবে / মার্কডাউন জিএফএম 1.1.0
  • s9e \ টেক্সটফর্মেটর (ফ্যাটডাউন / পিএইচপি)

3
দুর্দান্ত, পুরো পরীক্ষার সরঞ্জাম! দেখে মনে হচ্ছে আপনি ঠিক করছি # সব কিন্তু GFM জন্য কাজ এবং <> GFM জন্য কাজ দুয়েক অন্যদের কিন্তু নয়। খুব খারাপ জিএফএম উভয় একটি কর্নার কেস এবং একটি খুব জনপ্রিয় স্বাদ।
hobs

1
দেখে মনে হচ্ছে s9e \ টেক্সটফর্মেটর # 21 শে জানুয়ারী, 2016 এর সাথে কাজ করে Ce
ট্রয় ড্যানিয়েল

1
আশ্চর্যের বিষয় হল, মন্তব্যটি যদি (...)নিজে থেকে থাকে তবে তা এটি ভেঙে যায়। কমপক্ষে ভিজ্যুয়াল স্টুডিও কোড 1.19 এ on
রয়ী

1
এবং এইভাবে ভিআইএম ব্যবহারকারীদের জন্য যা সমস্ত ফাইল একবারে মন্তব্য করতে চায়:%s/^\(.*\)$/[comment]: # (\1)/g
সাইমন সি

এটি মার্কডাউন সম্পর্কে কী বলে যে বাইবেলমার্ক 2 বিদ্যমান?
টিসি প্রক্টর

53

আপনি যদি জ্যাকিল বা অষ্টপ্রেস ব্যবহার করছেন তবে এটিও কাজ করবে।

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

লিকুইড ট্যাগগুলি {% comment %}প্রথমে পার্স করা হয় এবং মার্কডাউন প্রসেসর এমনকি তার কাছে যাওয়ার আগে সরিয়ে ফেলা হয়। দর্শকরা তাদের ব্রাউজার থেকে উত্স দেখার চেষ্টা করবেন না।


2
জিনজা 2 = {#এখানে বহু লাইন মন্তব্য#}
জন মে

29

বিকল্প একটি স্টাইলাইজড এইচটিএমএল ট্যাগের মধ্যে মন্তব্য করা হয়। এইভাবে, আপনি প্রয়োজন হিসাবে তাদের দৃশ্যমানতা টগল করতে পারেন। উদাহরণস্বরূপ, আপনার সিএসএস স্টাইলশিটে একটি মন্তব্য শ্রেণি সংজ্ঞায়িত করুন।

.comment { display: none; }

তারপরে, নিম্নলিখিত বর্ধিত মার্কডডাউন

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

ব্রাউসারে নিম্নলিখিত হিসাবে উপস্থিত হয়

We do support comments


5
অনুলিপি / পেস্ট সম্ভবত "মন্তব্য করা" পাঠ্যটি অনুলিপি করার পাশাপাশি নিয়মিত পাঠ্যও শেষ হবে তাই এটি ব্যবহার করার সময় সতর্ক থাকুন। পাঠ্যের ব্লকটি অনুলিপি করার জন্য এটি সহজেই অপ্রত্যাশিত ফলাফল আনতে পারে।
আইলন

4
@ আইলনও এর অ্যাক্সেসযোগ্যতা ভয়াবহ হতে পারে
ইথান

অ্যাক্সেসিবিলিটি সমর্থনকারী ইঞ্জিনগুলি সঠিকভাবে প্রদর্শন এড়িয়ে যাবে: কোনও পাঠ্য নয়।
aredridel

28

এটি গিটহাবে কাজ করে:

[](Comment text goes here)

ফলাফল এইচটিএমএল এর মত দেখাচ্ছে:

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

যা মূলত একটি খালি লিঙ্ক। স্পষ্টতই আপনি রেন্ডার্ড পাঠ্যের উত্সটিতে এটি পড়তে পারেন, তবে আপনি যেভাবেই গিটহাবে এটি করতে পারেন।


6
এটি অবশ্যই, তবে এটি এখনও পর্যন্ত একমাত্র উত্তর যা সর্বদা গিটহাবের উপর কাজ করে, যেমন তালিকায়।
জোমো

আমি একই সমাধানে পৌঁছেছি। এটা শুধুমাত্র আমি ইন-লাইন মন্তব্যের জন্য কাজ করতে পারেন, যেমন এর some text [](hidden text) blah blah
c24w

3
এই এখন আর তা না, 2019-03-08 হিসাবে GitHub উপর কাজ করে এটি হিসাবে উপস্থাপনা হয়[](Comment text goes here)
dogmatic69


18

মার্কডাউন সরঞ্জামের ক্রমবর্ধমান সংখ্যার দ্বারা সমর্থিত সমালোচক মার্কআপও দেখুন।

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.

5
আমি মনে করি এই জাতীয় "সিউডো" -মান্ডার্ডগুলির মধ্যে একটি সমস্যা হ'ল তারা পোর্টেবল নয়। কিছু ওয়েবসাইটে, এগুলি নিখুঁতভাবে কাজ করবে, অন্যদের জন্য, তারা করবে না।
উইলেম ভ্যান অনসেম

14

কীভাবে মন্তব্যগুলিকে একটি নন-ইভাল, নন-ইকো আর ব্লকে রাখবেন? অর্থাত,

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

আমার জন্য ভাল কাজ মনে হচ্ছে।


2
এছাড়াও, cat("# Some Header")"মন্তব্যে আউট" কোড ব্লক এবং ব্যবহারের মতো results = "asis"কিছু করতে দ্বিধা বোধ করুন এবং আপনি আপনার কোডে সম্পূর্ণ মন্তব্য-আউট বিভাগগুলি যোগ করতে পারেন যা টগলিং দ্বারা চালিত / বন্ধ করা যায় eval = FALSE, যেহেতু আর মূল্যায়ন আগে করা হয় done প্যান্ডোক সংকলন ধারণার জন্য ধন্যবাদ!
মাইকেলচিরিকো

11

প্রকাশ: আমি প্লাগইনটি লিখেছি।

যেহেতু প্রশ্নটিতে একটি নির্দিষ্ট মার্কডাউন বাস্তবায়ন নির্দিষ্ট করা হয়নি আমি পাইথন- মার্কডাউন এর জন্য মন্তব্য প্লাগইন উল্লেখ করতে চাই , যা উপরে উল্লিখিত একই প্যান্ডোক মন্তব্য শৈলীর প্রয়োগ করে।


11
<!--- ... --> 

প্যান্ডোক মার্কডাউন (প্যান্ডোক 1.12.2.1) এ কাজ করে না। মন্তব্যগুলি এখনও এইচটিএমএলে হাজির। নিম্নলিখিত কাজ করেছে:

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

তারপরে + পাদটীকা এক্সটেনশনটি ব্যবহার করুন। এটি মূলত একটি পাদটীকা যা কখনও রেফারেন্স হয় না।


আমি এটি সর্বোত্তম পছন্দ করি কারণ এটি কোনও আউটপুট তৈরি করে না। Bitbucket এই উপসর্গ যথেষ্ট; [#]:
11

7

নিম্নলিখিত খুব ভাল কাজ করে

<empty line>
[whatever comment text]::

সেই পদ্ধতিটি রেফারেন্সের মাধ্যমে লিঙ্কগুলি তৈরি করতে সিনট্যাক্সের সুবিধা নেয়
যেহেতু তৈরি লিংক রেফারেন্সটি[1]: http://example.org রেন্ডার হবে না, তেমনি নিম্নলিখিতগুলির কোনওটি পাশাপাশি রেন্ডার করা হবে না

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

এটি (প্রথম পরীক্ষিত প্রথম রূপটি) গিটলব এবং গিটহাবেরpandoc বর্তমান অনলাইন উদাহরণগুলির জন্যও কাজ করে
দোয়াক

5

প্যান্ডোকের জন্য, মন্তব্যটি ব্লক করার একটি ভাল উপায় হ'ল ইয়ামল মেটাব্লক ব্যবহার করা, যেমন পান্ডোক লেখকের পরামর্শ হিসাবে । আমি লক্ষ্য করেছি যে এই অন্যান্য প্রস্তাবিত সমাধানের মধ্যে অনেকগুলির, আমার পরিবেশে অন্তত (তুলনায় মন্তব্যের আরো সঠিক সিনট্যাক্স হাইলাইটিং দেয় 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)) একইরকম অসুবিধে করার জন্য কাজ করে।


5

ক্র্যামডাউন - রুবি-ভিত্তিক মার্কডাউন ইঞ্জিন যা জেকিলের জন্য ডিফল্ট এবং এইভাবে গিটহাব পৃষ্ঠাগুলি তার এক্সটেনশন সিনট্যাক্সের মাধ্যমে অন্তর্নির্মিত মন্তব্য সমর্থন করেছে :

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

ইন-লাইন মন্তব্যের অনুমতি দেওয়ার সুবিধা রয়েছে তবে অন্য মার্কডাউন ইঞ্জিনগুলিতে পোর্টেবল না হওয়ার নেতিবাচক দিক রয়েছে।


4

আপনি চেষ্টা করতে পারেন

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

4

আপনি এটি করতে পারেন (ওয়াইএএমএল ব্লক):

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

আমি কেবল ক্ষীরের আউটপুট দিয়ে চেষ্টা করেছি, দয়া করে অন্যদের জন্য নিশ্চিত করুন।


এটি এইচটিএমএল আউটপুটও কাজ করে works
পেটজী

ড্যানিয়েলের এইচটিএমএল আউটপুট নিশ্চিতকরণ সঠিক কিনা তা আমি নিশ্চিত নই। আমি একটি এইচটিএমএল আউটপুট ফাইল দিয়ে এটি করেছি এবং "প্যান্ডোক - বিলিওগ্রাফি পেপার.বিব-পে পেপার.ইচটিএমএল পেপার.এমডি" চালিয়েছি এবং এইচটিএমএল মন্তব্য লাইনগুলি দেখিয়েছে।
মার্কগ্যালাসি
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.