Skip to content
| Marketplace
Sign in
Visual Studio Code>Programming Languages>AdocMD ForgeNew to Visual Studio Code? Get it now.
AdocMD Forge

AdocMD Forge

BucketHsu

|
93 installs
| (0) | Free
Professional AsciiDoc and Markdown workspace with live preview, syntax assistance, link diagnostics, image workflows, and HTML/PDF export.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

AdocMD Forge

AdocMD Forge

AdocMD Forge 是為 AsciiDoc 與 Markdown 打造的 VS Code 文件工作台,整合即時預覽、游標定位、語法輔助、圖片處理、文件導覽、連結檢查與 HTML/PDF 匯出。

功能特色

即時預覽

  • 支援 .adoc、.asciidoc 與 .md。

  • 編輯後自動更新,不需要重新開啟預覽。

  • 點選或移動來源編輯器游標時,預覽會跟隨目前行定位。

  • 預覽會以細緻外框標示目前來源區塊,並將該區塊置於預覽畫面中央,避免遮擋閱讀內容。

  • 來源編輯器游標與捲動會同步定位預覽;預覽區只有在點擊內容時才反向定位編輯器,直接滾動預覽不會拉動編輯器。

  • 支援僅來源、來源與預覽分割、僅預覽三種版面。

  • 自動配合 VS Code 深色、淺色與高對比佈景主題。

  • AsciiDoc 預覽可載入工作區範圍內的 :stylesheet:、:stylesdir:、圖片與 include::。

  • 被引用的文件、樣式表、圖片或 include 更新時,已開啟的預覽會自動重新整理。

編輯與語法輔助

  • 內建 AsciiDoc 語法醒目提示,涵蓋標題、屬性、清單、區塊、巨集、連結與行內格式。

  • 提供文件骨架、章節、表格、原始碼、admonition、xref、anchor、圖片與 include 等常用 Snippet。

  • 原生支援 VS Code Breadcrumbs、Go to Symbol 與程式碼摺疊。

  • 浮動格式面板提供粗體、斜體、注目、等寬、刪除線、上標與下標。

  • 選取文字後可從右鍵選單直接套用格式。

  • AsciiDoc 提供標題、清單、表格、區塊、連結、xref、anchor、圖片、include、attribute 與 TOC 的補全及 Hover 說明。

  • 內建繁體中文 AsciiDoc 語法指南與可直接使用的範例。

Windows/Linux macOS 用途

Ctrl+Alt+V

Cmd+Alt+V

開啟目前文件的預覽

Ctrl+B

Cmd+B

粗體

Ctrl+I

Cmd+I

斜體

Ctrl+Alt+C

Cmd+Alt+C

行內等寬文字

Ctrl+Shift+.

Cmd+Shift+.

開啟浮動格式面板

圖片工作流程

  • 將圖片拖曳或貼入編輯器時,可選擇工作區內的儲存位置。

  • AsciiDoc 自動插入 image::path[],Markdown 自動插入 ![alt](https://github.com/BucketHsu/adocmd-forge/raw/HEAD/path)。

  • Copy Image 可從檔案選擇器匯入圖片,適用於無法提供二進位剪貼簿資料的平台。

  • 同名檔案會產生新檔名,不會直接覆寫既有圖片。

Outline、工作區導覽與連結檢查

  • Explorer 的 Outline 顯示目前文件的標題階層,點選即可跳至來源位置。

  • 編輯 xref、include:: 或 image:: 時,可補全工作區內的文件、anchor 與資源路徑。

  • 圖片補全與連結檢查會依文件的 :imagesdir: 解析路徑。

  • F12/Go to Definition 可跳至被引用的文件或 anchor;文件連結也可直接開啟。

  • Find All References 可查詢工作區內指向同一 anchor 的引用。

  • Rename Symbol 可安全改名明確宣告的 anchor,並同步更新跨文件引用;自動標題 anchor 不會被直接改名。

  • AsciiDoc 可檢查 link:、xref:、<<…​>>、include::、圖片與 anchor。

  • Markdown 可檢查連結、圖片、標題 anchor 與自訂 anchor。

  • 找不到的本機目標會顯示於 Problems Panel。

  • AsciiDoc 拼錯的路徑或 anchor 可從 Problems Panel 或燈泡選單套用 Quick Fix。

匯出

格式 用途

HTML

完整 HTML5 文件;本機資源使用相對於輸出檔案的路徑。

Standalone HTML

完整 HTML5 文件;可讀取的工作區圖片會轉為 data URI,適合單檔交付。

Embedded HTML

只輸出可嵌入其他頁面的安全 HTML 片段,不包含完整文件外框。

PDF

呼叫本機 asciidoctor-pdf 產生 PDF,支援文件內的 theme 與字型設定。

系統需求

  • Visual Studio Code 1.97.0 以上。

  • PDF 匯出需另行安裝 Ruby 與 asciidoctor-pdf。

  • 使用 PlantUML、Mermaid、Graphviz 等圖表時,需另行安裝 asciidoctor-diagram 及對應工具。

安裝

Visual Studio Marketplace

  1. 開啟 VS Code 的 Extensions 檢視。

  2. 搜尋 AdocMD Forge。

  3. 確認 Publisher 為 BucketHsu,然後選擇 Install。

VSIX

也可以從 Extensions 檢視右上角的 …​ 選擇 Install from VSIX…​,或使用命令列:

code --install-extension adocmd-forge-<version>.vsix

快速開始

  1. 開啟 .adoc、.asciidoc 或 .md 文件。

  2. 從編輯器標題列選擇 Open Preview、按下 Ctrl+Alt+V(macOS 為 Cmd+Alt+V),或執行 AdocMD Forge: Open Preview。

  3. 在來源編輯器點選任一段落,預覽會移動到對應內容。

  4. 編輯文件後,預覽會自動更新。

  5. 使用 Explorer 的 Outline、F12 與 Find All References 導覽文件,或執行 Validate Links 檢查本機引用。

AsciiDoc 樣式表

已儲存的 AsciiDoc 文件可使用標準屬性指定本機 CSS:

:stylesheet: ../stylesheets/colony.css

也可以搭配 :stylesdir::

:stylesdir: ../stylesheets
:stylesheet: colony.css

CSS 必須實際存在,並位於目前文件或工作區允許的範圍內。載入結果會寫入 Output 面板的 AdocMD Forge 頻道。

pdf-theme、pdf-fontsdir 與 PDF 封面屬性只影響 PDF,不會改變 HTML 預覽樣式。

PDF 匯出

先安裝 Asciidoctor PDF:

gem install asciidoctor-pdf

使用圖表時可再安裝:

gem install asciidoctor-diagram

文件可直接宣告 PDF 設定:

:scripts: cjk
:source-highlighter: rouge
:pdf-theme: ../pdf-theme.yml
:pdf-fontsdir: C:/Windows/Fonts

pdf-fontsdir 只指定字型搜尋位置;實際使用的字型仍需在 PDF theme 的 font.catalog 與 font-family 中設定。

若文件使用圖表,可在 adocmdForge.export.asciidoctorPdfArguments 加入:

[
  "-r",
  "asciidoctor-diagram"
]

相對的 pdf-theme、pdf-themesdir 與 pdf-fontsdir 會以來源 .adoc 所在目錄解析。

指令

指令 用途

Open Preview

開啟目前 AsciiDoc 或 Markdown 文件的預覽。

Refresh Preview

立即重新產生預覽。

Source Only/Source and Preview/Preview Only

切換來源與預覽版面。

Show Formatting Palette

開啟浮動文字格式面板。

Bold/Italic/Highlight/Inline Code

套用常用文字格式。

Strike Through/Superscript/Subscript

套用刪除線、上標或下標。

Open AsciiDoc Syntax Guide

開啟內建繁體中文語法指南。

Copy Image

將圖片複製到工作區並插入圖片語法。

Refresh Outline

重新分析目前文件的標題階層。

Validate Links

檢查本機連結與引用並更新 Problems Panel。

Export HTML/Export Standalone HTML/Export Embedded HTML

匯出對應的 HTML 格式。

Export PDF

使用本機 asciidoctor-pdf 匯出 PDF。

命令面板中的完整名稱均以 AdocMD Forge: 開頭。

設定

設定 預設值 說明

adocmdForge.preview.allowRemoteImages

false

允許受信任工作區的預覽載入 HTTPS 圖片。

adocmdForge.preview.openToSide

true

在目前編輯器旁開啟預覽。

adocmdForge.preview.scrollSync

true

同步來源游標與預覽位置;點擊預覽內容時反向定位來源編輯器,直接滾動預覽不會反向捲動編輯器。

adocmdForge.preview.updateDelay

200

編輯後更新預覽的延遲毫秒數。

adocmdForge.images.directory

images

目前文件旁的預設圖片相對目錄。

adocmdForge.images.promptForPath

true

匯入圖片前詢問儲存位置。

adocmdForge.images.defaultAltText

filename

使用檔名或固定文字作為圖片替代文字。

adocmdForge.outline.updateDelay

150

文件修改後更新 Outline 的延遲毫秒數。

adocmdForge.diagnostics.updateDelay

150

文件修改後檢查本機引用的延遲毫秒數。

adocmdForge.export.asciidoctorPdfCommand

asciidoctor-pdf

PDF 匯出使用的本機指令或完整路徑。

adocmdForge.export.asciidoctorPdfArguments

[]

額外的 Asciidoctor PDF 參數;支援 {source}、{destination} 與 {workspace}。

設定可套用於 User、Workspace 或 Workspace Folder 層級。

安全性與隱私

  • 擴充套件不蒐集遙測資料,也不會主動傳送文件內容。

  • AsciiDoc 與 Markdown 產生的 HTML 會先經過安全處理再顯示於 Webview。

  • 未受信任工作區不讀取本機 include、圖片或連結目標。

  • 遠端圖片預設停用;啟用後也只允許 HTTPS。

  • 圖片、匯出目的地與本機引用均限制於允許的工作區範圍。

  • Link Checker 不會對 HTTP 或 HTTPS 網址發出探測請求。

  • 跨文件索引只在受信任工作區啟用,不會將索引或文件內容傳送至外部服務。

已知限制

  • Explorer 的 Outline 目前顯示 active editor 的文件結構;跨文件補全、Definition、References 與安全 Rename 仍會使用受信任工作區索引。

  • Link Checker 只驗證本機檔案與文件內 anchor,不檢查遠端網址是否可連線。

  • 含動態 AsciiDoc 屬性的路徑若無法安全解析,會略過本機檔案檢查。

  • 圖片貼上取決於 VS Code、作業系統與來源應用程式是否提供 image/* 或 files DataTransfer;無法取得時請使用拖曳或 Copy Image。

  • PDF 匯出依賴本機 Ruby、Asciidoctor PDF、字型與圖表工具;這些元件不包含於擴充套件內。

疑難排解

預覽沒有更新

執行 AdocMD Forge: Refresh Preview,並確認 adocmdForge.preview.updateDelay 設定有效。

游標移動時預覽沒有跟隨

確認 adocmdForge.preview.scrollSync 為 true。空白行或無獨立輸出內容的語法會定位到最近的可顯示段落。

預覽滾動時編輯器沒有跟著移動

這是預設行為。直接滾動預覽不會反向鎖定編輯器;若要定位來源,請點擊預覽中的文件內容。

本機樣式表沒有套用

確認文件已儲存、CSS 副檔名為 .css、路徑相對於文件或 stylesdir 正確,並查看 Output 面板的 AdocMD Forge 頻道。

圖片沒有顯示或插入

確認工作區已受信任、文件已儲存,且圖片與目的地位於工作區允許範圍內。

PDF 匯出找不到 asciidoctor-pdf

先執行 asciidoctor-pdf --version 確認命令可用;必要時將完整執行檔路徑填入 adocmdForge.export.asciidoctorPdfCommand。

PDF 沒有使用指定字型

確認字型檔位於 pdf-fontsdir,並在 PDF theme 的 font.catalog 與 font-family 中引用相同字型名稱。

授權

AdocMD Forge 依 MIT License 發行,詳見 LICENSE。

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
  • Your Privacy Choices
  • Consumer Health Privacy
© 2026 Microsoft