Obsidian Export 项目使用教程

最新推荐文章于 2024-10-11 07:51:48 发布

凤霞音Endurance

最新推荐文章于 2024-10-11 07:51:48 发布

阅读量1k

点赞数 10

本文链接：https://blog.csdn.net/gitblog_01036/article/details/142838057

版权

Obsidian Export 项目使用教程

obsidian-export Rust library and CLI to export an Obsidian vault to regular Markdown 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-export

1. 项目介绍

Obsidian Export 是一个 Rust 库和 CLI 工具，用于将 Obsidian 保险库导出为常规 Markdown 文件。它支持递归导出 Obsidian Markdown 文件到 CommonMark 格式，支持 [[note]] 样式的引用以及 [[note]] 文件的嵌入。此外，它还支持 .gitignore 风格的排除模式（默认：export-ignore），并自动排除 Git 忽略的文件。

Obsidian Export 运行在所有主要平台上，包括 Windows、Mac 和 Linux。请注意，Obsidian Export 并未得到 Obsidian 团队的官方认可，但它支持 Obsidian 的 Markdown 风格的大部分功能。

2. 项目快速启动

2.1 安装

2.1.1 预构建二进制文件

预编译的二进制文件适用于所有主要平台，可以从以下链接下载：

https://github.com/zoni/obsidian-export/releases

2.1.2 从源码构建

如果二进制文件不适用于您的平台，或者您不信任预构建的二进制文件，可以通过 Cargo（Rust 的官方包管理器）从源码编译 Obsidian Export。

首先，安装 Rust 工具链：

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

然后，使用 Cargo 安装 Obsidian Export：

cargo install obsidian-export

2.2 基本使用

Obsidian Export 的主要接口是 obsidian-export CLI 命令。以下是一个基本的导出示例：

obsidian-export /path/to/my-obsidian-vault /path/to/exported-notes/

这将把 my-obsidian-vault 中的所有文件导出到 exported-notes 目录中，除了那些在 .export-ignore 或 .gitignore 中列出的文件。

3. 应用案例和最佳实践

3.1 导出单个文件

如果您只想导出单个文件，可以使用以下命令：

obsidian-export my-obsidian-vault/some-note.md /tmp/export/

3.2 导出部分保险库

使用 --start-at 参数，您可以只导出保险库的一部分。例如，假设您的保险库结构如下：

my-obsidian-vault
├── Notes/
├── Books/
└── People/

您可以只导出 Books 目录中的笔记：

obsidian-export my-obsidian-vault --start-at my-obsidian-vault/Books exported-notes

4. 典型生态项目

4.1 Obsidian

Obsidian 是一个强大的知识管理和笔记工具，支持 Markdown 格式。Obsidian Export 是 Obsidian 生态系统中的一个重要工具，用于将 Obsidian 笔记导出为常规 Markdown 文件，以便在其他工具或平台上使用。

4.2 Hugo

Hugo 是一个静态站点生成器，支持 Markdown 文件。通过使用 Obsidian Export，您可以将 Obsidian 笔记导出为 Hugo 支持的 Markdown 格式，从而轻松地将您的笔记转换为静态网站。

4.3 Jekyll

Jekyll 是另一个流行的静态站点生成器，也支持 Markdown 文件。通过 Obsidian Export，您可以将 Obsidian 笔记导出为 Jekyll 支持的格式，从而在 Jekyll 项目中使用这些笔记。

通过这些生态项目，Obsidian Export 不仅扩展了 Obsidian 笔记的使用场景，还促进了不同工具之间的无缝集成。

obsidian-export Rust library and CLI to export an Obsidian vault to regular Markdown 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-export