Scrivomatic 项目教程

Scrivomatic 项目教程

scrivomatic A writing workflow using Scrivener's style system + Pandoc for output… 项目地址: https://gitcode.com/gh_mirrors/sc/scrivomatic

1. 项目介绍

Scrivomatic 是一个结合了 Scrivener 和 Pandoc 的写作工作流项目。Scrivener 是一个强大的写作工具，适用于各种类型的写作，而 Pandoc 是一个文档转换工具，可以将文本转换为多种格式。Scrivomatic 通过将这两个工具结合，提供了一个高效、灵活的写作和文档转换工作流。

Scrivomatic 的主要功能包括：

• 使用 Scrivener 的样式系统进行写作。
• 通过 Pandoc 将 Scrivener 项目转换为多种输出格式（如 PDF、HTML、DOCX 等）。
• 使用 Pandocomatic 管理 Pandoc 的设置，简化配置过程。

2. 项目快速启动

安装依赖

首先，确保你已经安装了 Scrivener、Pandoc 和 Pandocomatic。以下是安装步骤：

1. 安装 Scrivener：从官方网站下载并安装 Scrivener。
2. 安装 Pandoc：

   brew install pandoc
   

3. 安装 Pandocomatic：

   gem install paru pandocomatic
   

配置 Scrivomatic

1. 克隆 Scrivomatic 项目：

   git clone https://github.com/iandol/scrivomatic.git
   cd scrivomatic
   

2. 在 Scrivener 中打开项目，并按照 README 文件中的说明进行配置。

使用示例

以下是一个简单的使用示例，展示如何将 Scrivener 项目转换为 PDF 格式：

1. 在 Scrivener 中创建一个新项目，并编写你的内容。
2. 在项目中添加一个前言文档（front-matter），并配置 Pandoc 的输出选项。
3. 使用 Scrivener 的编译功能，选择 Pandoc 作为编译器，并选择输出格式为 PDF。
4. 点击“编译”按钮，Scrivener 将自动调用 Pandoc 生成 PDF 文件。

3. 应用案例和最佳实践

学术写作

Scrivomatic 特别适合学术写作，因为它可以轻松生成带有完整参考文献的 PDF 文档。你可以使用 Scrivener 组织你的研究笔记和参考文献，然后通过 Pandoc 生成符合学术出版标准的文档。

技术文档

对于技术文档的编写，Scrivomatic 提供了丰富的格式化选项，包括代码块、警告框和信息框等。你可以使用 Scrivener 的样式系统来定义这些格式，并通过 Pandoc 生成多种格式的文档。

协作编辑

Scrivomatic 支持多人协作编辑，特别是在需要频繁编译和生成文档的情况下。通过 Pandoc 的自动化功能，你可以轻松地将文档转换为多种格式，并自动上传到服务器或共享平台。

4. 典型生态项目

Pandoc

Pandoc 是 Scrivomatic 的核心组件之一，它是一个强大的文档转换工具，支持多种输入和输出格式。Pandoc 的灵活性和强大的功能使得它成为 Scrivomatic 工作流的关键部分。

Pandocomatic

Pandocomatic 是一个 Pandoc 管理工具，用于简化 Pandoc 的配置过程。通过 Pandocomatic，你可以创建和管理 Pandoc 的配置文件，并自动化复杂的文档转换流程。

Scrivener

Scrivener 是一个专业的写作工具，适用于各种类型的写作。它提供了强大的组织和编辑功能，特别适合长篇写作和学术研究。Scrivener 与 Pandoc 的结合，使得文档的编写和转换变得更加高效和灵活。

通过这些工具的结合，Scrivomatic 提供了一个完整的写作和文档转换工作流，适用于各种类型的写作和文档生成需求。

scrivomatic A writing workflow using Scrivener's style system + Pandoc for output… 项目地址: https://gitcode.com/gh_mirrors/sc/scrivomatic