跳至主要內容

The Native-First, High-Performance Markdown Plugin for JavaScript

Markdown text editor plugin that transforms a native textarea into a full editing suite. WYSIWYG and plain Markdown modes, live preview, RTL support, dark mode. Works with Django, HTMX, Laravel, React, and any stack.

理念:“本土第一”

大多數編輯器都打破了標準的網路工作流程。 MarkdownEditor 擁抱它。 由於它直接位於

快速實施

1. 安裝

您可以使用NPM安裝,直接匯入JavaScript文件,或使用CDN進行快速部署。

透過 NPM 安裝

bash
npm install markdown-text-editor
或者

使用 CDN

或者,在您的 HTML 中包含以下 CDN 鏈接

html
<script src="https://cdn.jsdelivr.net/npm/markdown-text-editor"></script>

2. HTML 結構

只需將

普通模式(預設)

專注於原始 Markdown 語法以提供輕量級體驗。

配置 財產/工具 描述
選項對象 placeholder 設定文字區域的佔位符文字(可選,因為您也可以使用標準 HTML 文字區域屬性)
mode: 'hybrid' 實現所見即所得的體驗,在您鍵入時即時呈現格式(粗體、斜體、標題)
工具列:決定工具列中顯示的工具
及其順序。
heading 開啟下拉式選單以選擇標題等級 H1–H6
bold 啟用粗體文字格式。
italic 啟用斜體文字格式。
strikethrough 允許文字刪除線。
ol (有序列表):將文字轉換為編號清單格式。
ul (無序列表):將文字轉換為項目符號清單。
checklist 在文字中新增複選框,使其非常適合任務、待辦事項清單或追蹤完成狀態。
blockquote 反白顯示引用或強調的文字。
code 將選定的文字包含在單一反引號中以實現內聯代碼。再次點選可刪除反引號。
codeblock 將選定的文字包裝在三重反引號圍欄代碼區塊中。再次點選可移除柵欄。
hr 在遊標位置插入一條 --- 水平線。
table 在遊標位置插入起始 2x3 Markdown 表格範本。
image 讓您透過 Markdown 語法插入圖片。
link 允許您向文字添加超連結。
undo 撤銷最後的變更。
redo 重新套用上次撤銷的變更。
indent 增加縮排等級。
outdent 降低壓痕等級。
preview 切換全螢幕並排預覽。預覽窗格中的核取方塊可按一下並立即更新 Markdown 來源。按 Esc 鍵退出全螢幕。
高級圖像上傳功能
允許配置圖像上傳到
您自己的伺服器並透過 API 設定圖像
路徑。這可以提高效能和 SEO。
fileInput accept:允許的映像檔類型陣列(例如'webp''avif')。
uploadUrl:透過 POST 傳送檔案的後端端點。
params:額外資料的可選物件(CSRF 令牌、使用者 ID、資料夾名稱)
altInput required: false:停用替代文字輸入驗證(預設為 true)

⌨️ 鍵盤快速鍵

常見的格式化操作可以直接從鍵盤觸發,無需觸摸工具列。每個快捷方式也顯示在對應的工具列按鈕的工具提示中。

捷徑 行動
Ctrl + B  /  ⌘ B 切換粗體
Ctrl + I  /  ⌘ I 切換斜體
Ctrl + K  /  ⌘ K 插入連結
Ctrl + `  /  ⌘ ` 切換內聯代碼
Ctrl + Shift + S  /  ⌘ ⇧ S 切換刪除線
Ctrl + Z  /  ⌘ Z 撤銷
Ctrl + Shift + Z  /  ⌘ ⇧ Z 重做
Tab 縮排選定的行
Shift + Tab 減少縮排選定的行
Ctrl + F  /  ⌘ F 打開尋找面板
Ctrl + H  /  ⌘ H 打開尋找和取代面板
Escape 關閉查找面板/退出全螢幕預覽

🔍 找出並找到代替

編輯器內提供內建尋找和取代面板 - 無需瀏覽器擴充功能或單獨的工具。

  • 按下 Ctrl + F(或 ⌘ F)開啟尋找面板
  • Ctrl + H(或⌘ H)開啟尋找和尋找視窗。更換面板
  • 搜尋不區分大小寫並顯示即時比賽計數器(例如3 / 12
  • 使用 ▲ / ▼ 按鈕或 Enter / Shift + Enter 導覽匹配項
  • 替換替換目前反白顯示的匹配項; 全部替換一次替換所有出現的內容
  • Escape 關閉面板並將焦點返回編輯器

此面板浮動在編輯器內容區域的右上角,不會中斷寫入。

🌙 主題化

MarkdownEditor 自動從周圍頁面繼承其主題 - 無需配置。編輯器在初始化時從最近的祖先讀取data-theme,因此它與您網站的主題保持同步。

主題如何解決(優先順序)

  1. theme option - 在選項物件中傳遞的明確覆蓋