v2.0.11

API 參考

最後更新


MDParser 的所有匯出;IIFE 版本以全域 MDParser 提供,ESM 版本同時提供 MDParser 與同名的具名匯出。

匯出


名稱簽章說明
Parse(content: string) => AST解析 Markdown,回傳 AST
AST.html() => string將 AST 輸出為 HTML,含跳脫與 raw HTML 清洗
AST.json() => BlockNode[]回傳節點的深拷貝,為不含 html() 的純 JSON 資料
Init(options?: InitOptions, endpoint?: DependencyEndpoint) => Promise<void[]>設定選項並載入啟用的依賴
Refresh(container?: ParentNode) => Promise<void>在已放進頁面的容器內渲染依賴、綁定複製與檔案連結
OnCopyClick(handler: (success: boolean, pre: HTMLElement) => void) => void註冊在內建 success/error 回饋之後執行的回呼,只保留最後一次
DEFAULT_ENDPOINTRequired<DependencyEndpoint>依賴的預設網址
PARSE_OPTIONS{ indent: number; fileEndpoint: string; hashtagEndpoint: string; parseHeading: boolean }目前生效的選項
ParseLines(lines: string[], nested?: boolean) => BlockNode[]區塊解析器本體,不處理註腳與參照連結

InitOptions


欄位型別預設說明
indentnumber4tab 換算的欄寬
enable{ mermaid?, latex?, highlight?, chartjs? }全部 false要載入的依賴
fileEndpointstring""檔案連結的網址,需含 {filepath},見 檔案連結
hashtagEndpointstring""#tag 連結的網址,需含 {tag},見 Hashtag 連結
parseHeadingbooleanfalse標題改輸出為 <h1>~<h6>,取代 <span>;只有布林值 true 會啟用

每次呼叫 Init() 都依當次的 options 重新設定;未帶的欄位回到預設值。

標題元素


設定 parseHeading: true 後,標題輸出為真正的標題元素,保留相同的 md-h1~md-h6 class 與外觀;再次呼叫 Init() 且未帶此選項時改回 <span>。
  1. <div id="out" class="nanomd"></div>
  2. <script>
  3. const out = document.getElementById("out");
  4. const md = "# Title\n## Section";
  5. MDParser.Init({ parseHeading: true });
  6. out.innerHTML = MDParser.Parse(md).html();
  7. console.log(out.innerHTML);
  8. MDParser.Init();
  9. console.log(MDParser.Parse(md).html());
  10. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

DependencyEndpoint


鍵預設
mermaidjshttps://cdn.jsdelivr.net/npm/mermaid@11.4.1/dist/mermaid.min.js
katexjshttps://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js
katexcsshttps://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css
googleprettifyjshttps://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js
chartjshttps://cdn.jsdelivr.net/npm/chart.js@4.5.1/dist/chart.umd.min.js

複製回呼


  1. <div id="out" class="nanomd"></div>
  2. <script>
  3. const out = document.getElementById("out");
  4. out.innerHTML = MDParser.Parse("~~~js\nconst a = 1;\n~~~").html();
  5. MDParser.OnCopyClick((success, pre) => {
  6. console.log("copied:", success, pre.getAttribute("name"));
  7. });
  8. MDParser.Refresh(out);
  9. console.log(Object.keys(MDParser).join(", "));
  10. </script>
即時預覽 · @pardnchiu/nanomd@2.0.11

節點型別見 AST 節點。
EN