Scrivomatic 项目教程

Scrivomatic 项目教程

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

1. 项目的目录结构及介绍

Scrivomatic 项目的目录结构如下：

scrivomatic/
├── Crossref-scriv.zip
├── Installing-Ruby.md
├── LICENSE
├── Quarto-scriv.zip
├── README.md
├── Scrivener + Quarto-scrivtemplate
├── Scrivener+Quarto.md
├── Scrivomatic-scrformat
├── Scrivomatic-scrivtemplate
├── TufteBook-scriv.zip
├── Typst-scriv.zip
├── Workflow-scriv.zip
├── _config.yml
├── pandoc-run.rb
├── pandocomatic.yaml
├── quarto-run.rb
├── scrivomatic
├── scrivomatic.alfredworkflow
├── scrivomatic.bat
├── test.md
└── typst-run.rb

目录结构介绍

• Crossref-scriv.zip: 包含与 Crossref 相关的文件。
• Installing-Ruby.md: 安装 Ruby 的说明文档。
• LICENSE: 项目的开源许可证文件。
• Quarto-scriv.zip: 包含与 Quarto 相关的文件。
• README.md: 项目的介绍和使用说明。
• Scrivener + Quarto-scrivtemplate: Scrivener 和 Quarto 的模板文件。
• Scrivener+Quarto.md: Scrivener 和 Quarto 的集成说明文档。
• Scrivomatic-scrformat: Scrivomatic 的格式文件。
• Scrivomatic-scrivtemplate: Scrivomatic 的模板文件。
• TufteBook-scriv.zip: TufteBook 的模板文件。
• Typst-scriv.zip: Typst 的模板文件。
• Workflow-scriv.zip: 工作流的模板文件。
• _config.yml: 项目的配置文件。
• pandoc-run.rb: Pandoc 的运行脚本。
• pandocomatic.yaml: Pandocomatic 的配置文件。
• quarto-run.rb: Quarto 的运行脚本。
• scrivomatic: Scrivomatic 的主文件。
• scrivomatic.alfredworkflow: Alfred 工作流的配置文件。
• scrivomatic.bat: Windows 批处理文件。
• test.md: 测试文件。
• typst-run.rb: Typst 的运行脚本。

2. 项目的启动文件介绍

Scrivomatic 项目的启动文件是 scrivomatic。这个文件是项目的主入口，负责启动整个工作流。

启动文件介绍

• scrivomatic: 这是一个脚本文件，用于启动 Scrivomatic 工作流。它包含了启动 Pandoc 和 Pandocomatic 的命令，以及配置文件的路径。

3. 项目的配置文件介绍

Scrivomatic 项目的配置文件主要包括 _config.yml 和 pandocomatic.yaml。

配置文件介绍

• _config.yml: 这是项目的全局配置文件，包含了项目的各种设置，如路径、模板、输出格式等。
• pandocomatic.yaml: 这是 Pandocomatic 的配置文件，定义了 Pandoc 的运行参数和输出格式。它允许用户自定义 Pandoc 的输出，并通过 Pandocomatic 管理这些设置。

通过这些配置文件，用户可以灵活地调整 Scrivomatic 的工作流，以满足不同的写作需求。

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