การอ้างอิง Docs Markdown

บทความนี้มีการอ้างอิงตามล docs.microsoft.com การเขียน Markdown (Docs)

Markdown เป็นภาษามาร์กอัปเบาพร้อมไวยากรณ์การจัดรูปแบบข้อความธรรมดา Docs สนับสนุนCommonMarkโดยเป็นไปตามข้อนา Markdown ที่แยกวิเคราะห์ผ่านเครื่องมือวิเคราะห์ของMarkdig Docs ยังสนับสนุนส่วนขยาย Markdown แบบเองที่ให้เนื้อหามากขึ้นในไซต์ Docs

คุณสามารถใช้ตัวแก้ไขข้อความใด ๆ เพื่อเขียน Markdown แต่เราแVisual Studioเขียนโค้ดกับ Docs Authoring Pack ชุดการเขียนเอกสาร (Docs Authoring Pack) มีเครื่องมือแก้ไขและฟังก์ชันการแสดงตัวอย่างที่ช่วยให้คุณเห็นว่าบทความของคุณจะมีลักษณะอย่างไรเมื่อแสดงบน Docs

การแจ้งเตือน (Note, Tip, Important, Caution, Warning)

การแจ้งเตือนเป็นส่วนขยาย Markdown เพื่อสร้างบล็อกข้อความที่อ้างอิงที่แสดงบนเอกสารที่มีสีและไอคอนซึ่งระบุความสัมมากของเนื้อหา

หลีกเลี่ยงบันทึกย่อ เคล็ดลับ และกล่องที่สําคัญ ผู้อ่านมักจะข้ามไป ควรใส่ข้อมูลนั้นลงในข้อความบทความโดยตรง

ถ้าคุณต้องใช้การแจ้งเตือน ให้จํากัดการแจ้งเตือนหนึ่งหรือสองรายการต่อบทความ ไม่ควรมีบันทึกย่อหลายรายการถัดจากกันในบทความ

สนับสนุนชนิดการแจ้งเตือนต่อไปนี้:

> [!NOTE]
> Information the user should notice even if skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Essential information required for user success.

> [!CAUTION]
> Negative potential consequences of an action.

> [!WARNING]
> Dangerous certain consequences of an action.

การแจ้งเตือนเหล่านี้มีลักษณะเป็นเช่นนี้บน Docs:

วงเล็บมุม

ถ้าคุณใช้วงเล็บมุมเปิดในข้อความในไฟล์ของคุณ (ตัวอย่างเช่น เพื่อแสดงถึงตัวแทนข้อความ) คุณจะต้องเข้ารหัสวงเล็บมุมเปิดด้วยตนเอง มิฉะนั้น Markdown จะเข้าใจว่าตั้งใจให้เป็นแท็ก HTML

ตัวอย่างเช่น การเข้ารหัส <script name> เป็น &lt;script name&gt;\<script name> หรือ

วงเล็บมุมไม่ควรจะหลีกในรูปแบบข้อความที่จัดรูปแบบเป็นโค้ดแบบอินไลน์หรือในบล็อกรหัส

เครื่องหมายอัญประกาศเดี่ยวและเครื่องหมายอัญประกาศ

ถ้าคุณคัดลอกจาก Word ลงในตัวแก้ไข Markdown ข้อความอาจประกอบด้วยเครื่องหมายอัญประกาศเดี่ยว (หยัก) อัจฉริยะ" หรือเครื่องหมายอัญประกาศ สิ่งเหล่านี้ต้องถูกเข้ารหัส หรือเปลี่ยนเป็นเครื่องหมายอัญประกาศเดี่ยวหรือเครื่องหมายอัญประกาศพื้นฐาน มิฉะนั้น คุณลงเอยด้วยสิ่งต่างๆ เช่นนี้เมื่อมีการเผยแพร่แฟ้ม: It’ s

ต่อไปนี้เป็นการเข้ารหัสสำหรับรุ่น “อัจฉริยะ" ของเครื่องหมายวรรคตอนเหล่านี้:

• เครื่องหมายอัญประกาศซ้าย (เปิด): “
• เครื่องหมายอัญประกาศขวา (ปิด): ”
• เครื่องหมายอัญประกาศอันเดียวหรือเครื่องหมายอัญประกาศเี่ยว ขวา (ปิด) : ’
• เครื่องหมายอัญประกาศอันเดียวซ้าย (เปิด) (ใช้ไม่บ่อย): ‘

Blockquotes

Blockquotes ถูกสร้างขึ้นโดยใช้อักขระ >:

> This is a blockquote. It is usually rendered indented and with a different background color.

ตัวอย่างก่อนหน้านี้แสดงผลดังนี้:

นี่คือบล็อกข้อความอ้างอิง ซึ่งมักจะแสดงเยื้องและด้วยสีพื้นหลังที่แตกต่างกัน

ข้อความตัวหนา และตัวเอียง

เมื่อต้องการจัดรูปแบบข้อความ ให้เป็นตัวหนา ให้ใส่ข้อความไว้ในเครื่องหมายดอกจันสองอัน:

This text is **bold**.

เมื่อต้องการจัดรูปแบบข้อความ เป็นตัวเอียงให้ใส่ข้อความไว้ในเครื่องหมายดอกจันอันเดียว:

This text is *italic*.

เมื่อต้องการจัดรูปแบบข้อความให้เป็น ทั้งเป็นตัวหนาและตัวเอียงให้ใส่ข้อความไว้ในเครื่องหมายดอกจันสามอัน:

This text is both ***bold and italic***.

สําหรับแนวทางเกี่ยวกับเวลาที่จะใช้ข้อความตัวหนาและตัวเอียง ให้ดู แนวทางการจัดรูปแบบข้อความ

ส่วนย่อยของโค้ด

Docs Markdown สนับสนุนการวางส่วนย่อยของโค้ดทั้งแบบอินไลน์ในประโยค และบล็อก "fenced" แยกกันระหว่างประโยค โปรดดูที่วิธีการ เพิ่มโค้ดลงใน docsเพื่ออ่านข้อมูลเพิ่มเติม

คอลัมน์

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

ในขณะที่ส่วนขยาย คอลัมน์ ยังคงใช้งานได้ เราไม่แนะนาให้สร้างเค้าโครงแบบปรับแต่งเองอีกต่อไป เราพบว่าเค้าโครงคอลัมน์แบบปรับแต่งเองหลายชุดมีปัญหาการเข้าถึงหรือการละเมิดแนวทางสไตล์เอกสาร อย่าสร้างเค้าโครงแบบปรับแต่งเอง ใช้คุณลักษณะเอกสารมาตรฐาน

ไวยากรณ์ของคอลัมน์มีดังนี้:

:::row:::
   :::column span="":::
      Content...
   :::column-end:::
   :::column span="":::
      More content...
   :::column-end:::
:::row-end:::

คอลัมน์ควรประกอบด้วย Markdown พื้นฐานรวมถึงรูปภาพเท่านั้น หัวเรื่อง ตาราง แท็บ และโครงสร้างที่ซับซ้อนอื่นๆ ไม่ควรรวมไว้ แถวไม่สามารถมีเนื้อหาใดๆ ภายนอกคอลัมน์ได้

ตัวอย่างเช่น Markdown ต่อไปนี้จะสร้างคอลัมน์หนึ่งคอลัมน์ที่ครอบคลุมความกว้างสองคอลัมน์ และคอลัมน์มาตรฐานหนึ่งคอลัมน์ (ไม่มี span )

:::row:::
   :::column span="2":::
      **This is a 2-span column with lots of text.**

      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vestibulum mollis nunc
      ornare commodo. Nullam ac metus imperdiet, rutrum justo vel, vulputate leo. Donec
      rutrum non eros eget consectetur.
   :::column-end:::
   :::column span="":::
      **This is a single-span column with an image in it.**

      ![Doc.U.Ment](media/markdown-reference/document.png)
   :::column-end:::
:::row-end:::

จะแสดงดังต่อไปนี้:

ข้อคิดเห็น

Docs สนับสนุนข้อคิดเห็น HTML ถ้าคุณต้องการแสดงความคิดเห็นในส่วนบทความของคุณ:

<!--- Here's my comment --->

หัวเรื่อง

Docs สนับสนุนหัวเรื่อง Markdown หกระดับ:

# This is a first level heading (H1)

## This is a second level heading (H2)

...

###### This is a sixth level heading (H6)

• ต้องมีช่องว่างระหว่างข้อความสุดท้าย # และข้อความหัวเรื่อง
• ไฟล์ Markdown แต่ละไฟล์ต้องมีหัวเรื่อง H1 หนึ่งรายการและมีเพียงหัวเรื่องเดียว
• หัวเรื่อง H1 ต้องเป็นเนื้อหาแรกในไฟล์หลังจากบล็อกเมตาดาต้าของ YML
• หัวเรื่อง H2 จะปรากฏในเมนูนําทางด้านขวามือของไฟล์ที่เผยแพร่โดยอัตโนมัติ หัวเรื่องที่ระดับล่างจะไม่ปรากฏขึ้น ดังนั้นให้ใช้ H2s ในเชิงกลยุทธ์เพื่อช่วยให้ผู้อ่านนําทางเนื้อหาของคุณ
• หัวเรื่อง HTML เช่น ไม่ <h1> แนะนาและในบางกรณีจะทําให้เกิดคําเตือนของบิลด์
• คุณสามารถเชื่อมโยงไปยังแต่ละหัวเรื่องในไฟล์ผ่าน ลิงก์บุ๊กมาร์ก

HTML

แม้ว่า Markdown สนับสนุน HTML แบบอินไลน์ HTML ไม่แนะแนวทางในการเผยแพร่ไปยัง Docs และเว้นแต่รายการของค่าที่จํากัดจะทําให้เกิดข้อผิดพลาดหรือคําเตือนของบิลด์

รูปภาพ

สนับสนุนชนิดไฟล์ต่อไปนี้ตามค่าเริ่มต้นสำหรับรูปภาพ:

• .jpg
• .png

เพื่อสนับสนุนชนิดรูปภาพอื่น ๆ เช่น .gifไฟล์ คุณต้องเพิ่มเป็นทรัพยากรใน docfx.json:

"resource": [
  {
    "files" : [
      "**/*.png",
      "**/*.jpg,
      "**/*.gif"
    ],

รูปภาพแนวคิดมาตรฐาน (Markdown ค่าเริ่มต้น)

ไวยากรณ์ Markdown พื้นฐานเพื่อฝังรูปภาพคือ:

![<alt text>](<folderPath>)

Example:
![alt text for image](../images/Introduction.png)

เมื่อ <alt text> คือคำอธิบายสรุปของรูปภาพและ <folder path> เส้นทางสัมพัทธ์ไปยังรูปภาพ ข้อความแสดงแทนจำเป็นสำหรับโปรแกรมอ่านหน้าจอสำหรับผู้ที่มีความบกพร่องในการมองเห็น ยังมีประโยชน์ถ้ามีบักของไซต์ที่รูปภาพไม่สามารถแสดงได้

ขีดล่างในข้อความแสดงแทนไม่แสดงอย่างเหมาะสมเว้นแต่ว่าคุณหลีกโดยการใส่ค่านําหน้าด้วยเครื่องหมายทับขวา ( \_ ) อย่างไรก็ตาม อย่าคัดลอกชื่อไฟล์เพื่อใช้เป็นข้อความแสดงแทน ตัวอย่างเช่น แทนที่จะเป็นอย่างนี้:

![ADextension_2FA_Configure_Step4](./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG)

เขียนสิ่งนี้:

![Active Directory extension for two-factor authentication, step 4: Configure](./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG)

ภาพแนวคิดมาตรฐาน (Docs Markdown)

ส่วนขยาย Docs :::image::: แบบปรับแต่งเองรองรับรูปภาพมาตรฐาน รูปภาพที่ซับซ้อน และไอคอน

ในรูปมาตรฐาน ไวยากรณ์ Markdown เก่าจะยังคงใช้งานแต่ส่วนขยายใหม่ได้รับการแนะนาเนื่องจากรองรับฟังก์ชันการฟังก์ชันที่มีประสิทธิภาพมากขึ้น เช่น การระบุขอบเขตการแปลที่แตกต่างจากหัวข้อหลัก ฟังก์ชันขั้นสูงอื่น ๆ เช่น การเลือกจากแกลเลอรีรูปภาพที่แชร์แทนการระบุรูปภาพภายในเครื่อง จะพร้อมใช้งานในอนาคต ไวยากรณ์ใหม่มีดังนี้:

:::image type="content" source="<folderPath>" alt-text="<alt text>":::

ถ้า type="content" (ค่าเริ่มต้น) ทั้ง source และ alt-text ก็ต้องการ

รูปภาพที่ซับซ้อนพร้อมการอธิบายที่ยาว

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

:::image type="complex" source="<folderPath>" alt-text="<alt text>":::
   <long description here>
:::image-end:::

ถ้า type="complex"source , , alt-text ข้อความอธิบายแบบยาว :::image-end::: และแท็กจะต้องทั้งหมด

เมื่อการเปลี่ยนแปลงของคุณอยู่ในตัวอย่างหรือเผยแพร่แล้ว คุณสามารถตรวจสอบว่ามีรายละเอียดที่ยาวหรือไม่โดยการคลิกขวาบนรูปภาพและเลือก ตรวจสอบ(เมื่อใช้เบราว์เซอร์ Microsoft Edge แม้ว่าเบราว์เซอร์อื่นมีคุณลักษณะที่คล้ายกัน) การแอคชันนี้พาคุณไปยังแหล่งรูปภาพในโค้ด HTML ซึ่งอยู่ด้านล่างซึ่งคุณจะพบ คลาสที่ซ่อนอยู่ ด้วยภาพ ขยายรายการแบบเลื่อนลงบนระดับชั้นนี้ และคุณจะพบการอธิบายแบบยาวของคุณ:

เส้นขอบอัตโนมัติ

:::image:::ส่วนขยายยังรองรับคุณสมบัติ border ซึ่งจะเพิ่มเส้นขอบสีเทา 1 พิกเซลรอบ ๆ รูปภาพของคุณโดยอัตโนมัติ borderคุณสมบัติ true จะเป็นค่าเริ่มต้นใน content และ รูปภาพ complex ดังนั้นคุณจะได้รับเส้นขอบโดยอัตโนมัติเว้นแต่ว่าคุณเพิ่มคุณสมบัติ พร้อมค่าของ false อย่างชัดเจน borderตามค่าเริ่มต้น คุณสมบัติ false นี้จะถูกแสดง icon เป็นรูปภาพ

คุณสมบัติ border เป็นวิธีที่แนะแนวในการเพิ่มเส้นขอบ อย่าสร้างเส้นขอบของคุณเองด้วยตนเอง

การระบุขอบเขต loc

บางครั้งขอบเขตการแปลเป็นภาษาท้องถิ่นของรูปภาพจะแตกต่างจากของบทความหรือโมดูลที่มี ซึ่งสามารถทําให้เกิดประสบการณ์ส่วนกลางที่ไม่ดี: ตัวอย่างเช่น ถ้าภาพหน้าจอของผลิตภัณฑ์ถูกแปลเป็นภาษาที่แปลเป็นภาษาที่ไม่พร้อมให้ใช้งานโดยไม่ได้ตั้งใจ เพื่อป้องกันปัญหานี้ คุณสามารถระบุแอตทริบิวต์ที่เลือกได้ในรูปภาพของชนิด และ และต้องมีภาพหน้าจอที่แสดงผลิตภัณฑ์ที่มีขอบเขตการแปลเป็นภาษาท้องถิ่นแตกต่างจาก loc-scopecontentcomplex บทความหรือโมดูลที่มี

ไอคอน

ส่วนขยายของรูปสนับสนุนไอคอน ซึ่งเป็นรูปภาพตกแต่งและไม่ควรมีข้อความแสดงแทน ไวยากรณ์ของไอคอนคือ:

:::image type="icon" source="<folderPath>":::

ถ้า type="icon"source ควรระบุ alt-text แต่ไม่ควรเป็น

borderตามค่าเริ่มต้น คุณสมบัติ false จะถูกตั้งค่าเริ่มต้นเป็น ไอคอน ถ้ารูปการตกแต่งของคุณต้องการเส้นขอบรูปภาพมาตรฐาน ให้ border="true" เพิ่มลงใน :::image::: แท็กอย่างชัดเจน

ไฟล์ Markdown ที่รวมอยู่ด้วย

เมื่อต้องซ้ําไฟล์ Markdown ในหลายบทความ คุณสามารถใช้ไฟล์รวมได้ คุณลักษณะ รวม จะสั่งให้ Docs แทนที่การอ้างอิงด้วยเนื้อหาของไฟล์รวมในเวลาที่สร้าง คุณสามารถใช้รวมถึงในวิธีต่อไปนี้:

• อินไลน์: ใช้อินไลน์ข้อความของส่วนย่อยทั่วไปกลับมาใช้ใหม่กับภายในประโยค
• บล็อก: นำแฟ้ม Markdown ทั้งหมดที่เป็นบล็อกกลับมาใช้ใหม ซ้อนอยู่ภายในส่วนของบทความ

ไฟล์รวมแบบอินไลน์หรือบล็อกเป็นไฟล์ Markdown (.md) แฟ้มดังกล่าวสามารถประกอบด้วย Markdown ที่ถูกต้องใดๆ ก็ได้ โดยทั่วไปไฟล์รวม จะอยู่ในไดเรกทอรีย่อย รวมในรากของที่เก็บ เมื่อมีการเผยแพร่บทความ แฟ้มที่รวมจะถูกรวมไว้ในนั้นอย่างราบรื่น

รวมไวยากรณ์

รวมบล็อกอยู่ในบรรทัดของตัวเอง:

[!INCLUDE [<title>](<filepath>)]

รวมแบบอินไลน์อยู่ภายในบรรทัด:

Text before [!INCLUDE [<title>](<filepath>)] and after.

<title>โดยที่ คือชื่อของไฟล์ และ <filepath> เส้นทางสัมพัทธ์ไปยังไฟล์ INCLUDE ต้องเป็นตัวพิมพ์ใหญ่และต้องมีช่องว่าง <title> ก่อน

ต่อไปนี้เป็นความต้องการและข้อควรพิจารณาสำหรับไฟล์รวม:

• ใช้รวมแบบบล็อกสำหรับจำนวนที่มีนัยสำคัญของเนื้อหา--ย่อหน้า หนึ่งหรือสอง กระบวนงานที่ใช้ร่วมกัน หรือส่วนที่ใช้ร่วมกัน ไม่ใช้กับทุกอย่างที่มีขนาดเล็กกว่าประโยค
• รวมจะไม่แสดงในมุมมองGitHubการแสดงผลบทความของคุณเนื่องจากขึ้นอยู่กับส่วนขยาย Docs จะแสดงหลังจากการเผยแพร่เท่านั้น
• เขียนข้อความทั้งหมดในไฟล์รวมในประโยคหรือวลีที่สมบูรณ์ ซึ่งไม่ขึ้นอยู่กับข้อความก่อนหน้าหรือข้อความต่อไปนี้ในบทความที่อ้างอิงรวม การละเว้นข้อแนะนํานี้จะสร้างสตริงที่ไม่สามารถแปลงในบทความได้
• ไม่ฝังไฟล์รวมไว้ภายในไฟล์รวมอื่นๆ
• /Includes โฟลเดอร์จะถูกแยกออกจากการสร้าง ดังนั้น รูปภาพที่ /includes จัดเก็บไว้ในโฟลเดอร์และไฟล์อ้างอิงที่รวมอยู่จะไม่แสดงในเนื้อหาที่เผยแพร่ จัดเก็บรูป /media ในโฟลเดอร์ /includes ภายนอกโฟลเดอร์
• เช่นเดียวกับบทความปกติ ไม่ใช้สื่อร่วมกันระหว่างรวมแฟ้ม ใช้แฟ้มแยกต่างหาก ด้วยชื่อที่ไม่ซ้ำสำหรับแต่ละการรวมและบทความ เก็บแฟ้มสื่อในโฟลเดอร์สื่อที่มีการเชื่อมโยงเข้ากับการรวม
• ไม่ใช้การรวมเป็นเนื้อหาของบทความเท่านั้น การรวมมีไว้เพื่อเป็นการเพิ่มเติมเนื้อหาในบทความส่วนที่เหลือ

ย่อหน้า

ใน Markdown ช่องว่างก่อนอักขระตัวแรกของบรรทัดจะพิจารณาการจัดแนวของบรรทัดเทียบกับบรรทัดก่อนหน้า การเยื้องโดยเฉพาะอย่างยิ่งมีผลต่อรายการที่มีล.อ. และที่มีสัญลักษณ์แสดงหัวข้อย่อย เพื่อแสดงซ้อนซ้อนกันหลายระดับในรูปแบบล.ก.ล.อ. หรือเค้าร่าง

เมื่อต้องการเยื้องข้อความเพื่อจัดแนวตามย่อหน้าก่อนหน้าหรือรายการในรายการที่มีล้ว่างหรือมีสัญลักษณ์แสดงหัวข้อย่อย ให้ใช้ช่องว่าง

สองตัวอย่างต่อไปนี้แสดงวิธีที่ย่อหน้าเยื้องแสดงตามความสัมพันธ์ของย่อหน้าอื่นๆ

1. This is a numbered list example (one space after the period before the letter T).
   This sentence is indented three spaces.
   This code block is indented three spaces.
   
- This is a bulleted list example (one space after the bullet before the letter T).
  This sentence is indented two spaces.
  > [!TIP]
  > This tip is indented two spaces.
  - This is a second-level bullet (indented two spaces, with one space after the bullet before the letter T).
    This sentence is indented four spaces.
    > This quote block is indented four spaces.

ตัวอย่างข้างต้นแสดงผลเป็น:

1. นี่คือตัวอย่างรายการลว่าง (ช่องว่างหนึ่งช่องว่างหลังมหัพถึงตัวอักษร T)

   ประโยคนี้จะเยื้องสามช่องว่าง

   This code block is indented three spaces.
   

• นี่คือตัวอย่างรายการมีสัญลักษณ์แสดงหัวข้อย่อย (ช่องว่างหนึ่งช่องว่างหลังสัญลักษณ์แสดงหัวข้อย่อยก่อนตัวอักษร T)

  ประโยคนี้จะเยื้องช่องว่างสองช่อง

  เคล็ดลับ

  เคล็ดลับนี้จะเยื้องช่องว่างสองช่อง

  • นี่คือสัญลักษณ์แสดงหัวข้อย่อยระดับที่สอง (เยื้องสองช่องว่าง ด้วยช่องว่างหนึ่งช่องหลังสัญลักษณ์แสดงหัวข้อย่อยก่อนตัวอักษร T)

    ประโยคนี้จะเยื้องสี่ช่องว่าง

    บล็อกข้อความอ้างอิงนี้จะเยื้องช่องว่างสี่ช่อง

การเชื่อมโยง

โปรดดูที่ ใช้ลิงก์ในเอกสารประกอบ เพื่อ ข้อมูลเกี่ยวกับไวยากรณ์ของลิงก์

รายการ (ลําดับเลข ที่มีสัญลักษณ์แสดงหัวข้อย่อย รายการตรวจสอบ)

รายการลำดับเลข

หากต้องการสร้างรายการล 1 ตารางให้ใช้ 1s ทั้งหมด ตัวเลขจะแสดงในลดับจากน้อยไปหามากเป็นรายการตามลดับเมื่อเผยแพร่ เพื่อให้อ่านได้แหล่งข้อมูลที่เพิ่มขึ้น คุณสามารถเพิ่มรายการของคุณด้วยตนเองได้

อย่าใช้ตัวอักษรในรายการ รวมถึงรายการที่ซ้อนกัน รายการจะไม่แสดงอย่างถูกต้องเมื่อถูกเผยแพร่ไปยัง Docs รายการที่ซ้อนกันที่ใช้ตัวเลขจะแสดงเป็นอักษรตัวพิมพ์เล็กเมื่อถูกเผยแพร่ ตัวอย่างเช่น:

1. This is
1. a parent numbered list
   1. and this is
   1. a nested numbered list
1. (fin)

จะแสดงดังต่อไปนี้:

1. นี่คือ
2. รายการลำดับเลข parent
   1. และนี่คือ
   2. รายการลำดับเลขซ้อน
3. (fin)

รายการมีสัญลักษณ์แสดงหัวข้อย่อย

เพื่อสร้างรายการมีสัญลักษณ์แสดงหัวข้อย่อย ให้ใช้ -* หรือตามด้วยช่องว่างในตอนต้นของแต่ละบรรทัด:

- This is
- a parent bulleted list
  - and this is
  - a nested bulleted list
- All done!

จะแสดงดังต่อไปนี้:

• นี่คือ
• รายการมีสัญลักษณ์แสดงหัวข้อย่อย parent
  • และนี่คือ
  • รายการมีสัญลักษณ์แสดงหัวข้อย่อยซ้อน
• ทั้งหมดเสร็จสิ้น!

ไวยากรณ์ใดก็ตามที่คุณใช้ หรือ -* ให้ใช้อย่างสอดคล้องกันภายในบทความ

รายการตรวจสอบ

รายการตรวจสอบจะพร้อมใช้งานบน Docs ผ่านทางส่วนขยาย Markdown แบบปรับแต่งเอง:

> [!div class="checklist"]
> * List item 1
> * List item 2
> * List item 3

ตัวอย่างนี้จะแสดงบน Docs ดังนี้:

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

แอคชันขั้นต่อไป

คุณสามารถใช้ส่วนขยายแบบปรับแต่งเพื่อเพิ่มปุ่มแอคชันขั้นต่อไปไปยังหน้าเอกสารได้

โดยมมีไวยากรณ์ดังต่อไปนี้:

> [!div class="nextstepaction"]
> [button text](link to topic)

ตัวอย่างเช่น:

> [!div class="nextstepaction"]
> [Learn about adding code to articles](code-in-docs.md)

จะแสดงดังต่อไปนี้:

คุณสามารถใช้ลิงก์สนับสนุนใด ๆ ในแอคชันขั้นต่อไป รวมทั้งลิงก์ Markdown ไปยังหน้าเว็บอื่น ในกรณีส่วนใหญ่ ลิงก์แอคชันถัดไปจะเป็นลิงก์แบบย่อไปยังอีกไฟล์หนึ่งใน docset เดียวกัน

สตริงที่ไม่แปลเป็นภาษาท้องถิ่น

คุณสามารถใช้ส่วนขยาย no-loc Markdown แบบปรับแต่งเพื่อระบุสตริงของเนื้อหาที่คุณต้องการละเว้นกระบวนการแปลเป็นภาษาท้องถิ่น

สตริงทั้งหมดที่ถูกเรียกออกมาจะเป็นตามตัวพิมพ์เล็ก-ใหญ่ นั่นคือ สตริงจะต้องตรงกับที่จะถูกละเว้นเพื่อการแปลเป็นภาษาท้องถิ่น

หากต้องการเครื่องหมายสตริงแต่ละรายการว่าไม่ใช่ภาษาท้องถิ่นได้ ให้ใช้ไวยากรณ์นี้:

:::no-loc text="String":::

ตัวอย่างเช่น ต่อไปนี้ จะไม่สนใจอินสแตนซ์เดียว Document ของ ในระหว่างกระบวนการแปลเป็นภาษาท้องถิ่นเท่านั้น:

# Heading 1 of the Document

Markdown content within the :::no-loc text="Document":::.  The are multiple instances of Document, document, and documents.

Lorem :::no-loc text="Find a \"Quotation\""::: Ipsum.

คุณยังสามารถใช้เมตาดาต้าในส่วนหัว YAML เพื่อเครื่องหมายอินสแตนซ์ทั้งหมดของสตริงภายในไฟล์ Markdown ปัจจุบันเป็นไม่สามารถเป็นภาษาท้องถิ่นได้:

author: cillroy
no-loc: [Global, Strings, to be, Ignored]

ในตัวอย่างต่อไปนี้ ทั้งในเมตาดา title ต้าและส่วนหัวของ Markdown จะถูก Document ละเว้นในระหว่างกระบวนการแปลเป็นภาษาท้องถิ่น

ในเมตา description ดาต้าและเนื้อหาหลักของ Markdown document ข้อความจะถูกแปลเป็นภาษาท้องถิ่นเนื่องจากไม่ได้เริ่มต้นด้วย D ตัวพิมพ์ใหญ่

---
title: Title of the Document
author: author-name
description: Description for the document
no-loc: [Title, Document]
---
# Heading 1 of the Document

Markdown content within the document.

ตัวเลือก

ตัวเลือกคือองค์ประกอบ UI ที่ให้ผู้ใช้สลับไปมาระหว่างหลาย flavors ของบทความเดียวกัน ซึ่งจะใช้ในชุดเอกสารบางชุดเพื่อแก้ไขปัญหาความแตกต่างในการใช้งานข้ามเทคโนโลยีหรือแพลตฟอร์ม ตัวเลือกสามารถใช้ได้มากที่สุดกับเนื้อหาแพลตฟอร์มบนอุปกรณ์เคลื่อนที่ของเราโดยทั่วไปแล้วกับนักพัฒนา

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

มีตัวเลือกอยู่สองชนิด คือ ตัวเลือกเดียวและตัวเลือกแบบหลายตัวเลือก

ตัวเลือกเดี่ยว

> [!div class="op_single_selector"]
> - [Universal Windows](../articles/notification-hubs-windows-store-dotnet-get-started/)
> - [Windows Phone](../articles/notification-hubs-windows-phone-get-started/)
> - [iOS](../articles/notification-hubs-ios-get-started/)
> - [Android](../articles/notification-hubs-android-get-started/)
> - [Kindle](../articles/notification-hubs-kindle-get-started/)
> - [Baidu](../articles/notification-hubs-baidu-get-started/)
> - [Xamarin.iOS](../articles/partner-xamarin-notification-hubs-ios-get-started/)
> - [Xamarin.Android](../articles/partner-xamarin-notification-hubs-android-get-started/)

...จะถูกแสดงเช่นนี้:

ตัวเลือกแบบหลากหลาย

> [!div class="op_multi_selector" title1="Platform" title2="Backend"]
> - [(iOS | .NET)](./mobile-services-dotnet-backend-ios-get-started-push.md)
> - [(iOS | JavaScript)](./mobile-services-javascript-backend-ios-get-started-push.md)
> - [(Windows universal C# | .NET)](./mobile-services-dotnet-backend-windows-universal-dotnet-get-started-push.md)
> - [(Windows universal C# | Javascript)](./mobile-services-javascript-backend-windows-universal-dotnet-get-started-push.md)
> - [(Windows Phone | .NET)](./mobile-services-dotnet-backend-windows-phone-get-started-push.md)
> - [(Windows Phone | Javascript)](./mobile-services-javascript-backend-windows-phone-get-started-push.md)
> - [(Android | .NET)](./mobile-services-dotnet-backend-android-get-started-push.md)
> - [(Android | Javascript)](./mobile-services-javascript-backend-android-get-started-push.md)
> - [(Xamarin iOS | Javascript)](./partner-xamarin-mobile-services-ios-get-started-push.md)
> - [(Xamarin Android | Javascript)](./partner-xamarin-mobile-services-android-get-started-push.md)

...จะถูกแสดงเช่นนี้:

Subscript และ superscript

คุณควรใช้ตัวบอกย่อยหรือตัวบอกลักษณะเฉพาะ เมื่อจําเป็นต้องใช้ความแม่นยําทางเทคนิค เช่น เมื่อเขียนเกี่ยวกับสูตรทางคณิตศาสตร์เท่านั้น อย่าใช้สไตล์ที่ไม่ใช่มาตรฐาน เช่น เชิงบรรยาย

ในทั้งสควลย่อยและสคริปต์พิเศษ ให้ใช้ HTML:

Hello <sub>This is subscript!</sub>

จะแสดงดังต่อไปนี้:

สวัสดี _{นี่คือรายการย่อย!}

Goodbye <sup>This is superscript!</sup>

จะแสดงดังต่อไปนี้:

ลา ^{ก่อน นี่คือตัวบอกลา!}

ตาราง

วิธีที่ง่ายที่สุดในการสร้างตารางใน Markdown คือ ใช้ไปป์และเส้น เพื่อสร้างตารางมาตรฐานพร้อมส่วนหัว ให้ตามเส้นแรกด้วยเส้นประ:

|This is   |a simple   |table header|
|----------|-----------|------------|
|table     |data       |here        |
|it doesn't|actually   |have to line up nicely!|

จะแสดงดังต่อไปนี้:

คุณสามารถจัดแนวคอลัมน์โดยใช้เครื่องหมายจุดคู่ (:):

| Fun                  | With                 | Tables          |
| :------------------- | -------------------: |:---------------:|
| left-aligned column  | right-aligned column | centered column |
| $100                 | $100                 | $100            |
| $10                  | $10                  | $10             |
| $1                   | $1                   | $1              |

จะแสดงดังต่อไปนี้:

ตัวแบ่งบรรทัดภายในข้อความในเซลล์ตารางใด ๆ

ข้อความยาวในตาราง Markdown อาจขยายตารางไปยังการนําทางด้านขวาและไม่สามารถอ่านได้ คุณสามารถแก้ไขได้โดยอนุญาตให้เอกสารแสดงภาพเพื่อแทรกตัวแบ่งบรรทัดโดยอัตโนมัติภายในข้อความเมื่อต้องการ เพียงตัดตารางด้วยคลาสแบบกำหนดเอง [!div class="mx-tdBreakAll"]

นี่คือตัวอย่าง Markdown ของตารางที่มีสามแถวซึ่งจะถูกตัดโดย div ด้วยชื่อคลาส mx-tdBreakAll

> [!div class="mx-tdBreakAll"]
> |Name|Syntax|Mandatory for silent installation?|Description|
> |-------------|----------|---------|---------|
> |Quiet|/quiet|Yes|Runs the installer, displaying no UI and no prompts.|
> |NoRestart|/norestart|No|Suppresses any attempts to restart. By default, the UI will prompt before restart.|
> |Help|/help|No|Provides help and quick reference. Displays the correct use of the setup command, including a list of all options and behaviors.|

ซึ่งจะถูกแสดงเช่นนี้:

ตัวแบ่งบรรทัดภายในแถวในเซลล์ตารางคอลัมน์ที่สอง

คุณอาจต้องการแทรกตัวแบ่งบรรทัดโดยอัตโนมัติภายในข้อความในคอลัมน์ที่สองของตารางเท่านั้น เมื่อต้องการจํากัดตัวแบ่งให้กับคอลัมน์ที่สอง ให้ใช้คลาส mx-tdCol2BreakAll โดยใช้ไวยากรณ์ div ตัวตัดตามที่แสดงไว้ก่อนหน้านี้

ความกว้างของคอลัมน์ที่ไม่สอดคล้องกันระหว่างตาราง

คุณอาจสังเกตเห็นว่าความกว้างของคอลัมน์ของตารางในบทความของคุณมีลักษณะคี่หรือไม่สอดคล้องกัน พฤติกรรมนี้เกิดขึ้นเนื่องจากความยาวของข้อความภายในเซลล์จะพิจารณาเค้าโครงของตาราง ขออภัย ไม่มีวิธีควบคุมวิธีการแสดงผลตาราง นี่คือข้อจํากัดของ Markdown แม้ว่าจะมีลักษณะดีที่จะมีความกว้างของคอลัมน์ตารางที่สอดคล้องกัน แต่ก็มีข้อเสียบางอย่างเช่นกัน:

• การใช้โค้ด HTML แทนด้วย Markdown จะหัวข้อที่ซับซ้อนขึ้นและไม่ได้สนับสนุนการร่วมสร้างจากชุมชน
• ตารางที่คุณปรับแต่งให้มีขนาดหน้าจอบางขนาดอาจไม่สามารถอ่านได้ตามขนาดหน้าจออื่น ตามที่แนะน้ได้แสดงภาพแบบตอบสนอง

ตารางเมทริกซ์ข้อมูล

ตารางเมทริกซ์ข้อมูลมีทั้งส่วนหัวและคอลัมน์แรกถ่วงน้ําหนัก โดยสร้างเมทริกซ์ด้วยเซลล์ว่างที่ด้านบนซ้าย Docs มี Markdown แบบปรับแต่งเองของตารางเมทริกซ์ข้อมูล:

|                  |Header 1 |Header 2|
|------------------|---------|--------|
|**First column A**|Cell 1A  |Cell 2A |
|**First column B**|Cell 1B  |Cell 2B |

ตัวอย่างแสดงผลเป็น:

รายการทั้งหมดในคอลัมน์แรกต้องถูกจัดลักษณะเป็นตัวหนา ( **bold** ); มิฉะนั้นตารางจะไม่สามารถเข้าถึงโปรแกรมอ่านหน้าจอหรือใช้ได้

ตาราง HTML

ไม่แนะนาตาราง HTML ใน Docs ตารางนั้นไม่สามารถอ่านได้ในแหล่งข้อมูล - ซึ่งเป็นหลักที่หลักหลักๆ ของ Markdown