मैं मार्कडाउन में नोट के लिए टेक्स्ट बॉक्स कैसे बना सकता हूं?


86

मैं मार्कडाउन में एक दस्तावेज लिख रहा हूं। मैं मार्कडाउन स्रोत से डॉक्स और टेक्स फाइल बनाने के लिए अद्भुत पैंडॉक का उपयोग कर रहा हूं। मैं पाठकों को सुझाव और नोट्स के लिए एक टेक्स्टबॉक्स देना चाहूंगा जिस तरह से प्रोग्रामिंग किताबें अक्सर करते हैं। मैं यह पता नहीं लगा सकता कि मार्कडाउन में यह कैसे करना है। क्या आप मदद कर सकते हैं?


Microsoft अपने प्रलेखन में इसके लिए अपने स्वयं के सिंटैक्स का उपयोग करता है, लेकिन यह आपके वातावरण में काम करने की संभावना नहीं है। पूर्णता के लिए यहां शामिल हैं और नीचे दिए गए उत्तरों की तुलना करें। github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/…
20

जवाबों:


95

मैं आमतौर पर मार्कडाउन ग्रंथों में अलर्ट बॉक्स (जैसे नोट या चेतावनी) डालने के लिए क्या करता हूं (न केवल पैंडोक का उपयोग करते समय, बल्कि हर उस मार्कडाउन का समर्थन करता है) दो क्षैतिज रेखाओं के साथ सामग्री के आसपास होता है:

---
**NOTE**

It works with almost all markdown flavours (the below blank line matters).

---

जो कुछ इस तरह होगा:


ध्यान दें

यह सभी मार्कडाउन फ्लेवर्स (नीचे की खाली लाइन के मामलों) के साथ काम करता है।


अच्छी बात यह है कि आपको इस बात की चिंता करने की जरूरत नहीं है कि कौन सा मार्कडाउन स्वाद समर्थित है या कौन सा एक्सटेंशन स्थापित या सक्षम है।

संपादित करें : जैसा कि @ filups21 ने टिप्पणियों में उल्लेख किया है, ऐसा लगता है कि ***RMarkdown में एक क्षैतिज रेखा का प्रतिनिधित्व किया जाता है। इसलिए, पहले उल्लिखित समाधान सभी मार्कडाउन स्वादों के साथ काम नहीं करता है क्योंकि यह मूल रूप से दावा किया गया था।


4
यह उपयोगी है, लेकिन यह RMarkdown / Rstduio / Knitr के साथ काम नहीं करता है
bjw

1
bjw - rmarkdown में एक क्षैतिज रेखा ***एक खाली रेखा से पहले है। वैकल्पिक रूप से, आप नोट को लाइन से शुरू करके एक ब्लॉकचोट में रख सकते हैं >(एक खाली लाइन से पहले भी)।
फाइलअप

80

GitHub के साथ, मैं आमतौर पर एक ब्लॉकचोट सम्मिलित करता हूं।

> **_NOTE:_**  The note content.

हो जाता है ...

नोट: नोट सामग्री।

बेशक, वहाँ हमेशा सादे HTML है ...


@KamilSJaron: एह? नहीं, वे नहीं हैं। क्या आप कोड ब्लॉक के बारे में सोच रहे हैं?
n

@ n-0101 आह, मैं ब्लॉकक्वाट को बैकक्वाटर के रूप में पढ़ रहा था। हालांकि, ट्रिपल बैकक्वाट्स वास्तव में लपेट नहीं रहे हैं।
कामिल एस जेरोन

3
मैं इस सार्वभौमिक समाधान को प्राथमिकता देता हूं। मुझे भी यूनिकोड इमोजीज़ का उपयोग करने में आनंद आता है, जैसे कि नोट को उपसर्ग करना > ℹ️ This is an informationया > ⚠️ This is a warning
पियरे_लॉनिक

1
यह और तालिका कीचड़ एकमात्र उत्तर हैं जो इस प्रश्न को हल करते हैं। कठिन नियम kludge शीर्ष जवाब द्वारा प्रस्तावित एक बॉक्स को दिखाने के लिए विफल रहता है और इस तरह इस सवाल को हल करने में विफल रहता है। वास्तव में, यह उत्तर @ pierre_loic के यूनिकोड आइकन के साथ युग्मित किया गया था, जो मॉड ज्यादातर ज्यादातर reStructuredText नोटों की नकल करता है
सेसिल करी

16

एक ही समस्या के लिए मैंने जो सबसे सरल समाधान पाया है, वह है एक पंक्ति और किसी हेडर के साथ कई लाइन टेबल का उपयोग करना (पहले कॉलम में एक छवि है और दूसरे में पाठ):

----------------------- ------------------------------------
![Tip](images/tip.png)\ Table multiline text bla bla bla bla
                        bla bla bla bla bla bla bla ... the
                        blank line below is important 

----------------------------------------------------------------

एक और दृष्टिकोण जो काम कर सकता है (पीडीएफ के लिए) लेटेक्स डिफ़ॉल्ट फॉक्स निर्देश का उपयोग करना है :

 \fbox{My text!}

या अधिक उन्नत सुविधाओं (और बेहतर दिखने वाले बक्से) के लिए फैंसीबॉक्स मॉड्यूल: http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox


1
क्या आप जानते हैं कि अगर यह संभव है कि पैंडॉक-मार्कडाउन नोट पैंडॉक टेम्पलेट फ़ाइल के अंदर कैसा दिखेगा? उदाहरण के लिए, संपादन ~ / .pandoc / टेम्पलेट्स / default.latex?
टेमरिक

11

सामंजस्य विस्तार का उपयोग करें । के लिए mkdocs , उस में विन्यस्त किया जा सकता mkdocs.ymlफ़ाइल:

markdown_extensions:
    - admonition

फिर अपनी md फाइलों में नोट को इस प्रकार डालें:

!!! note

     This is a note.

एक उदाहरण यहाँ देखें ।


8

एटिने के समाधान के समान, एक साधारण टेबल प्रारूप अच्छी तरह से:

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

एक अन्य विकल्प (जो अधिक जोर के साथ आता है), सामग्री को बॉडी-लेस टेबल के हेडर बनाने के लिए है:

|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|
|-|-|

अंत में, आप एक बंद बॉक्स बनाने के लिए एक क्षैतिज रेखा (विषयगत विराम) को शामिल कर सकते हैं (हालाँकि पंक्ति शैली तालिका में शीर्ष लेख की रेखा से थोड़ी भिन्न है):

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

---

पाठ के बाद खाली लाइन पर ध्यान दें।


मुझे यह समाधान बहुत पसंद है, लेकिन जब मैं इसे pandoc और xelatex के माध्यम से pdf में रूपांतरित करता हूं, तो ऐसा लगता है कि यह " NOTE" कॉलम के लिए 50% और अन्य के लिए 50% आवंटित करता है; एक stackoverflow.com/questions/27219629 के अनुसार बहु-तालिकाओं का उपयोग कर सकता है - लेकिन फिर अन्य स्वरूपण समस्याएं हैं।
sdbbs

6

यहाँ एक सरल लेटेक्स-आधारित उदाहरण है।

---
header-includes:
    - \usepackage[most]{tcolorbox}
    - \definecolor{light-yellow}{rgb}{1, 0.95, 0.7}
    - \newtcolorbox{myquote}{colback=light-yellow,grow to right by=-10mm,grow to left by=-10mm, boxrule=0pt,boxsep=0pt,breakable}
    - \newcommand{\todo}[1]{\begin{myquote} \textbf{TODO:} \emph{#1} \end{myquote}}
---

blah blah

\todo{something}

blah

जिसके परिणामस्वरूप: यहां छवि विवरण दर्ज करें

दुर्भाग्य से क्योंकि यह लेटेक्स है, आप अब TODO बॉक्स के अंदर मार्कडाउन को शामिल नहीं कर सकते हैं (जो कि एक बड़ी समस्या नहीं है, आमतौर पर), और यह पीडीएफ (उदाहरण के लिए html) के अलावा अन्य प्रारूपों में परिवर्तित होने पर काम नहीं करेगा।


5

निम्नलिखित तरीके GitHub पर, GitLab पर ... और Stackoverflow पर काम करते हैं, जो अब CommonMark का उपयोग करता है !


> ब्लॉक-लाइन के साथ बनाई गई वन-लाइन बॉक्स

ब्लॉकचोट के साथ बनाई गई वन-लाइन बॉक्स


`एक-पंक्ति बॉक्स Backticks के साथ बनाया`

One-Line Box made with Backticks


`` `
बॉक्स ट्रिपल बैकिक्स के साथ बना`
``

Box made with Triple Backticks  


~ ~ ~
बॉक्स ट्रिपल टिल्ड्स के साथ बनाया गया
(इस काम को करने के लिए टिल्ड्स के बीच रिक्त स्थान को हटा दें)
~ ~ ~

Box made with Triple Tildes


प्रत्येक पंक्ति के प्रारंभ में चार स्थानों के साथ बनाया गया बॉक्स :

    “Sometimes we must let go of our pride and do what is requested of us.”
    Padmé Amidala


... या क्षैतिज रेखाओं का उपयोग करें?

तीन डैश (---) एक क्षैतिज रेखा बनाते हैं:


नोट : "आपका ध्यान आपकी वास्तविकता को निर्धारित करता है।" - क्यूई-गॉन जिन


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

उपयोगी संकेत:

  • एक नई रेखा को बाध्य करने के लिए, पंक्ति के अंत में दो रिक्त स्थान डालें;

  • विशेष वर्णों से बचने के लिए, का उपयोग करें।


3

क्या आपने डबल टैब का उपयोग करने की कोशिश की है? एक बॉक्स बनाने के लिए:

Start on a fresh line
Hit tab twice, type up the content
Your content should appear in a box

यह मेरे लिए एक नियमित रूप से Rmarkdown दस्तावेज़ में HTML आउटपुट के साथ काम करता है। डबल-टैब्ड भाग को एक गोल आयताकार हल्के ग्रे बॉक्स में दिखाई देना चाहिए।


VS कोड और GitHub पर भी काम करता है!
नागदेव

यह एक कोड ब्लॉक है।
CivFan

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.