Obsidian 本身是一款强大的本地笔记应用,但借助一些工具和模板,你可以将 Obsidian 笔记转换为在线网站。其中,Quartz 是一个基于 Obsidian 的静态网站生成器,使用相对简单,可以帮助你快速搭建一个个人知识库网站。

以下是如何使用 Quartz 搭建网站的详细步骤:

前提条件

  1. 安装 Obsidian:确保你已经安装了 Obsidian 并且有一些笔记内容。
  2. 安装 Git:Quartz 使用 Git 进行版本控制和网站部署,因此需要安装 Git。
  3. GitHub 账户:你需要一个 GitHub 账户来托管你的网站。
  4. Node.js 和 npm:Quartz 需要 Node.js 和 npm 来构建和运行。

步骤一:克隆 Quartz 仓库

首先,从 GitHub 克隆 Quartz 的模板仓库:

  1. 打开终端或命令提示符。

  2. 运行以下命令克隆仓库:

    git clone https://github.com/jackyzha0/quartz.git
    cd quartz

步骤二:安装依赖

在 Quartz 项目目录下,安装所需的 Node.js 依赖:

npm install

步骤三:配置 Quartz

配置 Quartz 以适应你的需求:

  1. 打开 config.yml 文件,根据你的需求进行编辑。例如,设置网站的标题、作者等信息。
  2. 将你的 Obsidian 笔记内容放入 content 文件夹中。你可以直接复制 Obsidian 笔记库中的 Markdown 文件。

步骤四:本地预览

在本地预览你的网站,以确保一切正常:

npm run dev

打开浏览器,访问 http://localhost:8080 查看网站效果。如果有任何问题,可以根据错误提示进行调试。

步骤五:部署到 GitHub Pages

  1. 在 GitHub 上创建一个新的仓库,命名为 username.github.io,其中 username 是你的 GitHub 用户名。

  2. 将 Quartz 项目的内容推送到这个仓库:

    git remote set-url origin https://github.com/username/username.github.io.git
    git add .
    git commit -m "Initial commit"
    git push -u origin main
  3. 在 GitHub 仓库的设置中,找到 GitHub Pages 选项,并将其设置为从 main 分支的根目录进行部署。

步骤六:配置域名(可选)

如果你有自己的域名,可以通过以下步骤配置自定义域名:

  1. 在 GitHub Pages 的设置中,添加你的自定义域名。
  2. 在域名注册商的控制面板中,添加一个 CNAME 记录,指向 username.github.io

结束语

通过以上步骤,你应该能够成功使用 Quartz 将 Obsidian 笔记转化为一个在线网站。这种方法不仅能够帮助你更好地分享和展示你的知识库,还能提高知识管理的效率。如果在操作过程中遇到任何问题,可以参考 Quartz 的官方文档或相关社区寻求帮助。

加群交流

如果在使用和学习中有不明白的地方,或者想看看别人的经验,可以加入QQ群,

  • QQ群:980865715