在文檔處理和知識管理中,Markdown因其簡潔易讀的特性而廣受歡迎,而PDF格式則因其廣泛的兼容性和穩定性而被廣泛用于文檔分享和存檔。然而,將Markdown文檔高效地轉換為PDF格式,同時保留格式和樣式,一直是許多用戶的需求。今天推薦一款好用的工具——mdout。它是一個用Go語言實現的Markdown轉PDF命令行工具,基于headless Chrome技術,具備簡單、可靠、易安裝、可定制化和易拓展等特點。無論你是開發者、技術作家還是普通用戶,mdout都能滿足你將Markdown文檔轉換為PDF的需求,同時支持HTML和URL輸入,提供了豐富的自定義選項,讓你能夠輕松生成符合個人或項目需求的PDF文檔。
使用場景
技術文檔編寫
對于開發者和技術人員來說,編寫技術文檔是日常工作的一部分。使用Markdown格式編寫文檔既方便又高效,但有時需要將這些文檔轉換為PDF格式以便分享或存檔。mdout能夠快速將Markdown文檔轉換為PDF,同時保留代碼塊、數學公式等格式,確保技術文檔的專業性和可讀性。
學術寫作
學術研究中,研究人員經常需要撰寫論文、報告等文檔,這些文檔通常包含大量的數學公式和圖表。mdout支持MathJax數學公式和Mermaid流程圖,能夠將這些復雜的內容準確地轉換為PDF格式,滿足學術寫作的需求。
項目文檔管理
在項目管理中,項目文檔的整理和歸檔非常重要。mdout可以幫助項目團隊將Markdown格式的項目文檔轉換為PDF格式,方便團隊成員查閱和存檔。同時,支持自定義主題和輸出路徑,使得文檔管理更加靈活和高效。
4. 個人知識管理
對于個人用戶來說,使用Markdown記錄筆記和知識是一種常見的做法。mdout可以將這些Markdown筆記轉換為PDF格式,方便用戶進行知識整理和分享。支持HTML和URL輸入,使得用戶可以將網頁內容快速轉換為PDF,豐富知識庫的內容。
安裝步驟
mdout 的安裝分為三步:
- 獲取 mdout 可執行文件
- 配置 mdout 命令
- 下載 mdout 主題
1.1 腳本一鍵安裝
自取安裝包:https://pan.quark.cn/s/1e4d35cf8d4d
支持 macOS 或者 linux 、Windows系統
- mdout.linux.x86-64.tar.gz 7.82 MB
- mdout.macOS.x86-64.tar.gz 7.72 MB
- mdout_windows_x86-64.tar.gz 7.65 MB
- github # 主題包
1.2 windows配置和安裝步驟
下載好 mdout_windows_x86-64.tar.gz
安裝包,右鍵解壓即可獲得 mdout.exe
創建 mdout.exe
存放文件夾,例如 我的是存放電腦中的 D:\mdout
設置環境變量,右鍵我的電腦 -> 選擇屬性 -> 左邊的高級系統設置
選擇高級 -> 點擊環境變量
找到下半部分的系統變量,雙擊 Path
行
在彈出來的窗口選擇新建
填入mdout.exe 文件 所在路徑,我這里是 D:\mdout
,然后一定要連續點完三個確定
檢驗是否成功打開 cmd 或者 powershell ,再或者 gitbash 都可以(推薦使用命令行的 windows 用戶都至少裝一個 gitbash ),輸入 mdout
,看到如下輸出就是成功了
1.3 linux配置和安裝步驟
下載好安裝包、并用tar命令解壓文件
tar -xvzf mdout.linux.x86-64.tar.gz
放入系統可執行文件目錄
sudo mv mdout /usr/local/bin
檢驗是否成功
# 看到版本號輸出就成功
mdout --version
1.4 macOS配置和安裝步驟
下載好安裝包、并用tar命令解壓文件
tar -xvzf mdout.macOS.x86-64.tar.gz
放入系統可執行文件目錄
mv mdout /usr/local/bin
檢驗是否成功
# 看到版本號輸出就成功
mdout --version
配置文件夾說明
你輸入mdout
命令的時候, 會自動在用戶的家目錄下創建一個名為 mdout 的配置文件夾,并且在一般而言結構應該如下所示:
mdout
|-- conf.toml
|-- log
| `-- xxxx-x.log
`-- theme|-- github|-- css|-- index.html`-- lib
不同系統的家目錄不同,最終導致不同平臺的 mdout 配置文件夾路徑不同,以下表格以用戶為 jabin
舉例,在不同系統的路徑:
系統 | 配置文件夾路徑 |
---|---|
windows | C:/Users/jabin/mdout |
linux | /home/jabin/mdout |
macOS | /Users/jabin/mdout |
初始化mdout 主題包
1.1 手動配置github主題包
假設我的電腦登錄用戶是jabin
參考 配置文件夾說明
中的不同平臺配置文件夾路徑以及文件位置,進入mdout/theme
文件夾,將下載好的 github 主題包放到到C:/Users/jabin/mdout/theme/
文件夾中。
1.1 使用幫助
每個命令行程序都有幫助文檔,mdout也不例外
mdout -h
mdout --help
1.2 輸入文件路徑可以是相對路徑
最簡單的示例,默認就是轉換成pdf文檔
mdout 文件路徑
輸入文件路徑可以是相對路徑、文件在當前目錄
mdout yourfile.md
或文件在上級目錄
mdout ../yourfile.md
文件路徑也可以是絕對路徑
mdout /tmp/markdown/yourfile.md
1.4 輸入文件類型
mdout支持許多輸入類型,其中最普遍的就是markdown,但同樣也支持html輸入,url輸入,但是注意,如果輸入是url,不要忘記帶上http://
markdown轉換pdf
mdout yourfile.md
html轉換成pdf
mdout yourfile.html
url獲取數據轉換成pdf
mdout http://www.baidu.com
1.5 輸出文件類型
對于markdown輸入,mdout支持輸出中間過程的結果。但對于html輸入或者url輸入,它們的唯一輸出結果就是pdf文件了
markdown 輸出pdf(輸出pdf為默認選項)
mdout youtfile.md -t pdf
mdout yourfile.md
markdown輸出解析后html標簽(這個選項可以得到markdown解析器的解析結果)
mdout youtfile.md -t tag
markdown輸出經過處理后的完整html文件(常常用來調試主題)
mdout youtfile.md -t html
使用總結
mdout是一款功能強大、操作簡單的Markdown轉PDF工具。它基于headless Chrome技術,能夠高效地將Markdown文檔轉換為PDF格式,同時支持HTML和URL輸入,滿足不同用戶的需求。mdout的自定義主題功能允許用戶根據自己的喜好調整文檔的樣式和格式,而易安裝和易拓展的特點使得它適合各種技術水平的用戶。無論是在技術文檔編寫、學術寫作、項目文檔管理還是個人知識管理中,mdout都能發揮重要作用,幫助用戶高效地完成文檔轉換和管理任務。如果你經常需要處理Markdown文檔并將其轉換為PDF格式,mdout絕對值得一試的哈。
GitHub項目地址:https://github.com/JabinGP/mdout/tree/master