v2.0.11

區塊語法

最後更新


本頁涵蓋標題、段落與空行、引言與 GitHub 提示框、水平線與 raw HTML 行。

標題


寫法輸出
#~###### 加空白與文字md-h1~md-h6
文字下一行接 ===md-h1(Setext)
文字下一行接 ---md-h2(Setext)
任何標題,搭配 Init({ parseHeading: true })以相同 class 的 <h1>~<h6> 取代 <span>;見 API 參考

標題內可使用所有行內格式。

段落與空行


寫法結果
相鄰的兩行文字合併為同一段,中間以換行字元連接,畫面上顯示為空白
一個或多個空行一個 break 節點,連續空行只輸出一次
文件結尾的空行不輸出

引言與提示框


> 開頭的行組成引言,內容可再放任何區塊;>> 為巢狀引言。
第一行只寫 [!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING]、[!CAUTION](不分大小寫)時,輸出為對應的提示框。同一行還有其他文字,或標記出現在巢狀引言內時,維持一般引言。

水平線


***、---、___,三個以上相同字元,中間可夾空白(如 - - -)。

raw HTML


以 HTML 標籤開頭的整行原樣保留為 html 節點,輸出時移除危險標籤、事件屬性與 javascript: 網址,見 安全性。
raw HTML 內作者寫的換行(<br>、<br/>、<br />)會輸出為 <br class="md-br"> 並正常顯示;解析器為空行輸出的 <br> 則由 parser.css 隱藏。v2.0.11 之前兩者都會被隱藏,兩個徽章之間的 <br> 不會換行。

範例


標題


1~6 級 ATX 標題搭配行內格式,以及 Setext 標題。
  1. <div id="out" class="nanomd"></div>
  2. <script type="text/markdown" id="md">
  3. # Heading H1 *(1)*
  4. ## Heading H2 _(1)_
  5. ### Heading ~~H3~~
  6. #### Heading ==H4==
  7. ##### Heading H5
  8. ###### Heading H6
  9. Setext H1^(2)^
  10. ===
  11. Setext H2~(2)~
  12. ---
  13. </script>
  14. <script>
  15. const out = document.getElementById("out");
  16. out.innerHTML = MDParser.Parse(document.getElementById("md").textContent).html();
  17. MDParser.Refresh(out);
  18. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

段落與空行


相鄰兩行合併為同一段;連續三個空行只輸出一個 break。
  1. <div id="out" class="nanomd"></div>
  2. <script type="text/markdown" id="md">
  3. Paragraph merge: two adjacent lines
  4. become one paragraph joined by a soft break.
  5. Three blank lines below produce a single break.
  6. This line follows the merged break.
  7. </script>
  8. <script>
  9. const out = document.getElementById("out");
  10. out.innerHTML = MDParser.Parse(document.getElementById("md").textContent).html();
  11. MDParser.Refresh(out);
  12. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

引言與提示框


巢狀引言、五種 GitHub 提示框,以及維持一般引言的標記寫法。
  1. <div id="out" class="nanomd"></div>
  2. <script type="text/markdown" id="md">
  3. > First quote line
  4. > Second quote line **bold**
  5. >> Nested quote **bold**
  6. > [!NOTE]
  7. > Useful information users should know, even when skimming.
  8. > [!TIP]
  9. > Helpful advice, with **bold** and `code`.
  10. > [!IMPORTANT]
  11. > Key information users need to know.
  12. >
  13. > - Lists work inside
  14. > - Second item
  15. > [!WARNING]
  16. > Urgent info that needs immediate attention.
  17. > [!CAUTION]
  18. > Advises about risks or negative outcomes.
  19. Not alerts (marker only, text on the marker line, nested in a quote):
  20. > [!NOTE]
  21. > [!TIP] text on the same line
  22. > Outer quote
  23. >> [!WARNING]
  24. >> Marker inside a nested quote
  25. </script>
  26. <script>
  27. const out = document.getElementById("out");
  28. out.innerHTML = MDParser.Parse(document.getElementById("md").textContent).html();
  29. MDParser.Refresh(out);
  30. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

raw HTML 換行


raw HTML 區塊內的 <br> 會換行,區塊之間的空行則不會產生可見的換行。
  1. <div id="out" class="nanomd"></div>
  2. <script type="text/markdown" id="md">
  3. <p align="center">
  4. <a href="https://github.com/pardnchiu/NanoMD"><img src="https://img.shields.io/badge/NANOMD-PARSER-blue?style=for-the-badge" alt="NanoMD"></a><br>
  5. <a href="https://www.npmjs.com/package/@pardnchiu/nanomd"><img src="https://img.shields.io/npm/v/@pardnchiu/nanomd?style=for-the-badge" alt="npm"></a>
  6. </p>
  7. <div>line one<br/>line two<br />line three</div>
  8. </script>
  9. <script>
  10. const out = document.getElementById("out");
  11. out.innerHTML = MDParser.Parse(document.getElementById("md").textContent).html();
  12. MDParser.Refresh(out);
  13. console.log(out.querySelectorAll("br.md-br").length + " author <br> kept, " + out.querySelectorAll("br:not(.md-br)").length + " blank-line <br> hidden");
  14. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

水平線與 |


三種水平線寫法,以及含 | 但不是表格的行。
  1. <div id="out" class="nanomd"></div>
  2. <script type="text/markdown" id="md">
  3. Lines containing | that are not tables keep their block type:
  4. # Heading A | B
  5. > Quote a | b
  6. ***
  7. - - -
  8. ___
  9. </script>
  10. <script>
  11. const out = document.getElementById("out");
  12. out.innerHTML = MDParser.Parse(document.getElementById("md").textContent).html();
  13. MDParser.Refresh(out);
  14. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11
EN