寫文建站文章的 Markdown 與嵌入寫法
最近一次變動
修改前
Markdown 語法指南
修改後
寫文建站文章的 Markdown 與嵌入寫法
修改前
本指南示範 EdgePress 文章支援的 Markdown 功能。原始檔保持易讀,渲染後的 HTML 會先經過淨化再顯示於頁面。
修改後
寫文建站文章由 YAML 中繼資料和後面的 Markdown 正文組成。先用指令產生檔案,再編輯第二道 --- 之後的正文。下面集中列出一篇實際筆記會用到的寫法:
修改前
標題與段落
修改後
## What I noticed
修改前
在標題前加上井字號即可設定層級。空白行會開始新的段落。
修改後
A paragraph with emphasis, a link and inline code.
修改前
Heading level three
修改後
- A short list
- Another point
修改前
Heading level four
修改後
A quoted observation.
修改前
Heading level five
Heading level six
Setext heading level two
在行尾加入反斜線可以產生硬換行。
這一行仍屬於同一個段落。
分隔線
常見的三種寫法都會產生水平分隔線:
強調與程式碼
可以使用 斜體、粗體 和 刪除線。行內程式碼寫作 npm run build。
const greeting = "Hello, Markdown.";
也可以用波浪線包住程式碼:
This block uses a tilde fence.
每行縮排四個空格也會產生程式碼區塊:
const indented = "four spaces";
使用 ` 可以在程式碼片段中顯示一個反引號。
在程式碼片段中寫 \*,可以示範轉義後的星號。字元參照 < 和 & 會顯示為一般文字。
連結與圖片
修改後
| Step | Result |
|---|---|
| Build | Static HTML |
修改前
GFM 會將裸網址自動轉換為連結:https://www.markdownguide.org/ 。尖括號網址、www 網域和電子郵件地址也會自動辨識:https://commonmark.org www.example.com team@example.com。
修改後
- ✓ Draft
- □ Preview
修改前
展示 Markdown 文件如何產生靜態頁面的示意圖<img src="/edgepress/revisions/image.a33c96a36cc3638b.svg" alt="展示 Markdown 文件如何產生靜態頁面的示意圖" loading="lazy" width="1200" height="360" />
修改後
A photograph
修改前
以圖片語法連結 MP4 檔案時,會產生影片播放器:
修改後
Report
修改前

修改後
!embedishare
修改前
清單與引用
清單項目中也可以使用 格式。
- 在無序清單中巢狀有序項目。
- 再新增一個巢狀項目。
✓ 已完成工作會帶有無障礙狀態標籤。
□ 未完成工作會使用另一種狀態標籤。
修改後
正文支援標題、段落、強調、連結、清單、引用、程式碼圍欄、GFM 表格和工作清單。程式碼放在三道反引號之間,並註明語言。文章標題已由頁面顯示,正文章節從 ## 開始。
修改前
區塊引用中可以放入清單:
- 第一個引用項目。
- 第二個引用項目。
修改後
媒體先放在 content/assets/,再引用站點根路徑。圖片開啟共享檢視器;明確指定的原圖位址在點擊後請求。本地文件由可重用文件檢視器自動預覽;外部文件需要登記服務、目前同意與 CORS。
修改前
區塊引用也可以繼續巢狀。
這是內層引用。
表格與安全 HTML
| Syntax | Rendered form |
|---|---|
# Heading |
A heading |
**text** |
Strong emphasis |
修改後
!embed[ishare](URL) 獨佔一行,EXAMPLE 要換成實際發布的分享連結。使用前在 plugins.consent.services 註冊服務,請求等待同意和實際載入需求。同樣的擴充行也能寫在 Pages 的 text 元素裡,不要把嵌入放進文章前置資料。
修改前
需要時可以使用 Ctrl 這類語意化行內 HTML。淨化器會移除 等主動內容。
修改後
Pages 使用結構化元素,不要把整篇 Markdown 文章貼進文字欄位。排版參考完整 Pages 範例。寫作時用 npm run dev 預覽,發布前建置。
寫文建站文章由 YAML 中繼資料和後面的 Markdown 正文組成。先用指令產生檔案,再編輯第二道 --- 之後的正文。下面集中列出一篇實際筆記會用到的寫法:
## What I noticed
A paragraph with **emphasis**, a [link](https://example.org/) and `inline code`.
- A short list
- Another point
> A quoted observation.
| Step | Result |
| --- | --- |
| Build | Static HTML |
- [x] Draft
- [ ] Preview

!document[Report](/documents/report.pdf)
!embed[ishare](https://ishare.js.gripe/s/EXAMPLE)
正文支援標題、段落、強調、連結、清單、引用、程式碼圍欄、GFM 表格和工作清單。程式碼放在三道反引號之間,並註明語言。文章標題已由頁面顯示,正文章節從 ## 開始。
媒體先放在 content/assets/,再引用站點根路徑。圖片開啟共享檢視器;明確指定的原圖位址在點擊後請求。本地文件由可重用文件檢視器自動預覽;外部文件需要登記服務、目前同意與 CORS。
!embed[ishare](URL) 獨佔一行,EXAMPLE 要換成實際發布的分享連結。使用前在 plugins.consent.services 註冊服務,請求等待同意和實際載入需求。同樣的擴充行也能寫在 Pages 的 text 元素裡,不要把嵌入放進文章前置資料。
Pages 使用結構化元素,不要把整篇 Markdown 文章貼進文字欄位。排版參考完整 Pages 範例。寫作時用 npm run dev 預覽,發布前建置。