zk-publisher 中文文档教程
ZD-Publisher
该项目处于初始阶段，致力于建立一个简单的命令行机制来发布 Obsidian 跳至内容合理的网站。
这是一个需要解决的必然复杂的问题。
该项目的一些总体目标：
- 支持 Evergreen 笔记作为源内容样式，用于发布紧急学习和内容，例如 根据 Andy Matuschak 对 Evergreen Notes 的定义
- 支持根据元数据（例如标签）进行结构性导航内容的方法
- 支持自然地导航内容库中的常规 wiki 样式链接，例如支持内容地图样式 导航
- 提供了一种基于元数据发布丰富内容的机制
- 具有可扩展的内容转换机制，可以支持新兴市场的临时消费者 工件
当前状态
使用 EJS 作为转换为 HTML 的 Markdown 页面的模板引擎。目前默认模板不可配置， 但这是我们的最终意图。
将 Markdown 元数据中的 type:presentation 识别为内容提示，表明 Markdown 将作为 推介会。目前使用 pandoc 将该内容转换为 PowerPoint (PPTX) 格式。使用的模板不是 可配置，但这就是我们的最终意图。
安装 ZK-Publisher
npm install -g zk-publisher
运行 ZK-Publisher
了解可用选项：
zk-publisher --help
最简单的用法是：
zk-publisher -s [Path To My Vault]
在 MacOS 上，默认情况下，您创建的名为 Main 的保管库可能会在某个地方找到 例如$HOME/Library/Mobile Documents/iCloud~md~obsidian/Documents/Main。
如果您没有使用 -o 选项指定输出目录，则会在您的目录中创建一个名为 output 的目录。 当前目录。
需要一个临时目录来保存 Vault 到普通 Markdown 的中间转换（完成 通过黑曜石导出）。如果您没有指定它的位置，它将在您的当前目录中创建。 目前，该工具不会删除此临时目录。
运行时要求
您的路径中必须有以下工具：
obsidian-exportpandoc
ZD-Publisher
This project is in the initial stages, working towards a simple command-line mechanism that will publish an Obsidian Vault to a reasonable content website.
This is a necessarily complicated problem to solve.
Some overall goals of the project:
- support Evergreen notes as a source content style, for publishing emergent learning and content, as per Andy Matuschak's definition of Evergreen Notes
- support a means of structurally navigating content according to metadata (eg tags)
- support naturally navigating content from regular wiki-style links in your vault, eg supporting Maps of Content style navigation
- provide a mechanism to publish rich content based on metadata
- with an extensible mechanism for content transformation that can support casual consumers of the emergent artifacts
Current State
Uses EJS as a template engine for markdown pages converted to HTML. Currently the default template is not configurable, but that's our eventual intent.
Recognizes type: presentation in markdown metadata as a content hint that the markdown is to be published as a presentation. Currently uses pandoc to convert that content to PowerPoint (PPTX) format. The template used is not configurable, but that's our eventual intent.
Installing ZK-Publisher
npm install -g zk-publisher
Running ZK-Publisher
Get a sense of the available options:
zk-publisher --help
The simplest usage is:
zk-publisher -s [Path To My Vault]
On MacOS, by default a vault you create called Main will likely be found someplace like $HOME/Library/Mobile Documents/iCloud~md~obsidian/Documents/Main.
If you do not specify an output directory with the -o option, a directory will be created called output in your current directory.
A temporary directory is required to hold an intermediate conversion of your Vault into plain markdown (done via obsidian-export). If you do not specify a location for it, it will be created in your current directory. Currently, the tool does not delete this temporary directory.
Runtime Requirements
You must have the following tools on your path:
obsidian-exportpandoc
