跳转至

Obsidian + mkdocs

Obsidian

https://obsidian.md/

MkDocs

install

# 確保 Python 環境可用
pip install mkdocs
# 建議安裝一個常用的主題,如 Material for MkDocs (推薦)
pip install mkdocs-material

建立 MkDocs 專案

# 進入您的工作目錄
cd /path/to/your/publishing/folder
# 建立新的 MkDocs 專案
mkdocs new my-docs

這會產生兩個核心文件:

  1. mkdocs.yml: 配置文件。
  2. docs/: 存放 Markdown 內容的資料夾。

連結 Obsidian 筆記

核心步驟: Obsidian 筆記庫中的內容複製到 MkDocs 的 docs/ 資料夾中。

# 假設您想發布 Obsidian 庫中的 'Public' 資料夾
cp -R /path/to/Obsidian_Vault/Public /path/to/my-docs/docs

配置 mkdocs.yml (核心設定)

mkdocs.yml

同步腳本

sync-obsidian.bash