ฉันจะสร้างกล่องข้อความสำหรับบันทึกย่อใน markdown ได้อย่างไร

ฉันกำลังเขียนเอกสารใน markdown ฉันใช้ pandoc ที่ยอดเยี่ยมเพื่อสร้างไฟล์ docx และ tex จากซอร์ส markdown ฉันต้องการมีกล่องข้อความสำหรับเคล็ดลับและหมายเหตุถึงผู้อ่านในแบบที่หนังสือการเขียนโปรแกรมมักจะทำ ฉันคิดไม่ออกว่าจะทำอย่างไรใน markdown คุณสามารถช่วย?

สิ่งที่ฉันมักจะทำเพื่อใส่กล่องแจ้งเตือน (เช่นหมายเหตุหรือคำเตือน) ในข้อความมาร์กดาวน์ (ไม่เพียง แต่เมื่อใช้ pandoc แต่ยังรองรับทุกที่ที่มาร์กดาวน์ด้วย) ล้อมรอบเนื้อหาด้วยเส้นแนวนอนสองเส้น:

---
**NOTE**

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

---

ซึ่งจะเป็นดังนี้:

บันทึก

ใช้ได้กับทุกรสชาติที่มาร์กดาวน์ (บรรทัดด้านล่างมีความสำคัญ)

สิ่งที่ดีคือคุณไม่จำเป็นต้องกังวลว่าจะรองรับรสชาติมาร์กดาวน์ใดหรือส่วนขยายใดที่ติดตั้งหรือเปิดใช้งาน

แก้ไข : ตามที่ @ filups21 ได้กล่าวไว้ในความคิดเห็นดูเหมือนว่าเส้นแนวนอนจะแสดงโดย***ใน RMarkdown ดังนั้นวิธีการแก้ปัญหาที่กล่าวถึงก่อนหน้านี้ไม่สามารถใช้ได้กับรสชาติที่มาร์กดาวน์ทั้งหมดตามที่อ้างไว้ในตอนแรก

เมื่อใช้ GitHub ฉันมักจะใส่ blockquote

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

กลายเป็น...

หมายเหตุ: เนื้อหาหมายเหตุ

แน่นอนว่ามี HTML ธรรมดาเสมอ ...

วิธีแก้ปัญหาที่ง่ายที่สุดที่ฉันพบในปัญหาเดียวกันคือการใช้ตารางหลายบรรทัดกับหนึ่งแถวและไม่มีส่วนหัว (มีรูปภาพในคอลัมน์แรกและข้อความในคอลัมน์ที่สอง):

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

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

อีกวิธีหนึ่งที่อาจใช้ได้ผล (สำหรับ PDF) คือการใช้คำสั่งfboxเริ่มต้นของ Latex :

 \fbox{My text!}

หรือโมดูล FancyBox สำหรับคุณสมบัติที่สูงขึ้น (และกล่องดูดี): http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox

ใช้ส่วนขยายคำตักเตือน สำหรับmkdocsสามารถกำหนดค่าได้ในmkdocs.ymlไฟล์:

markdown_extensions:
    - admonition

จากนั้นใส่บันทึกในไฟล์ md ของคุณดังนี้:

!!! note

     This is a note.

ดูตัวอย่างที่นี่

คล้ายกับโซลูชันของ Etienne ซึ่งเป็นรูปแบบตารางที่เรียบง่าย:

| | |
|-|-|
|`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.|

---

สังเกตบรรทัดว่างหลังข้อความ

นี่คือตัวอย่างง่ายๆจากลาเท็กซ์

---
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

ซึ่งส่งผลให้:

น่าเสียดายเนื่องจากนี่เป็นลาเท็กซ์คุณจึงไม่สามารถรวม markdown ไว้ในกล่อง TODO ได้อีกต่อไป (ซึ่งโดยปกติแล้วไม่ใช่ปัญหาใหญ่) และจะไม่ทำงานเมื่อแปลงเป็นรูปแบบอื่นที่ไม่ใช่ PDF (เช่น html)

วิธีการต่อไปนี้ใช้ได้กับ GitHub บน GitLab ... และบน Stackoverflowซึ่งตอนนี้ใช้CommonMark !

> กล่องบรรทัดเดียวทำด้วย Blockquote

กล่องบรรทัดเดียวทำด้วย Blockquote

`One-Line Box ทำด้วย Backticks`

One-Line Box made with Backticks

``
กล่องทำด้วย Triple Backticks
''

Box made with Triple Backticks  

~ ~ ~
กล่องที่ทำด้วย Triple Tildes _{^{(ลบช่องว่างระหว่างทิลด์เพื่อให้ทำงานนี้)}}
~ ~ ~

Box made with Triple Tildes

กล่องที่สร้างด้วย Four Spacesที่จุดเริ่มต้นของแต่ละบรรทัด:

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

... หรือใช้เส้นแนวนอน?

สามขีด (---) สร้างเส้นแนวนอน:

หมายเหตุ :“ โฟกัสของคุณกำหนดความเป็นจริงของคุณ” - Qui-Gon Jinn

สำหรับการกำหนดค่ามากขึ้นผมขอให้คำแนะนำที่ดีเยี่ยมGitLab Markdown คู่มือ
คุณยังสามารถตรวจสอบไวยากรณ์การจัดรูปแบบพื้นฐานของ GitHub ที่มีรายละเอียดน้อยได้
คุณสามารถเปรียบเทียบการใช้งาน Markdown โดยใช้Babelmark Babelmark

คำแนะนำที่เป็นประโยชน์:

• ในการบังคับขึ้นบรรทัดใหม่ให้ใส่ช่องว่างสองช่องที่ท้ายบรรทัด

• เพื่อหลีกเลี่ยงอักขระพิเศษให้ใช้ \.

คุณได้ลองใช้แท็บสองครั้งหรือไม่? ในการทำกล่อง:

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

มันใช้ได้กับฉันในเอกสาร Rmarkdown ปกติพร้อมเอาต์พุต html ส่วนที่เป็นแท็บสองครั้งควรปรากฏในกล่องสี่เหลี่ยมสีเทาอ่อนที่โค้งมน

คุณสามารถใช้https://www.npmjs.com/package/markdown-it-container

::: warning
*here be dragons*
:::

จากนั้นจะแสดงผลเป็น:

<div class="warning">
<em>here be dragons</em>
</div>

อีกวิธีหนึ่งคือการใช้ CSS adjacency และใช้ h4 (หรือสูงกว่า):

#### note

This is the note content

h4 {
  display: none; /* hide */
}

h4 + p {
  /* style the note however you want */
}