Scrivener Starter 项目教程
项目介绍
Scrivener Starter 是一个旨在使 Scrivener 项目与 Git 版本控制系统友好兼容的启动项目。Scrivener 是一个面向结构化和编辑长篇作品(如小说和论文)的写作应用程序。它主要被作家和学者用于组织那些在传统线性编辑器中难以管理的作品。Scrivener 项目以 .scriv
扩展名的应用程序包形式布局,这些包非常适合使用 Git 进行版本控制。
项目快速启动
克隆项目
首先,克隆 Scrivener Starter 项目到本地:
git clone https://github.com/carsomyr/scrivener_starter.git
cd scrivener_starter
重命名项目
将项目重命名为你的项目名称(例如 my_project
):
git mv starter.scriv my_project.scriv
git mv my_project.scriv/starter.scrivx my_project.scriv/my_project.scrivx
打开并保存项目
使用 Scrivener 打开重命名后的项目并保存:
open my_project.scriv
提交更改
提交初始更改到 Git:
git add -u
git commit -m "Rename the project"
编写内容并提交
在 Scrivener 中编写一些内容并保存,然后检查并提交未跟踪的文本资产:
git add my_project.scriv/Files/Docs/*.rtf
git add -u
git commit -m "Make some changes"
应用案例和最佳实践
应用案例
Scrivener Starter 适用于需要版本控制的长篇写作项目,如小说、学术论文、剧本等。通过 Git 管理,可以轻松跟踪更改、协作和备份。
最佳实践
- 定期提交更改:在 Scrivener 中进行重要更改后,及时提交到 Git,以便跟踪和恢复。
- 使用
.gitignore
:项目中已包含.gitignore
文件,用于忽略临时和元数据文件,保持 Git 状态清晰。 - 分支管理:使用 Git 分支进行不同版本的实验和开发,确保主分支的稳定性。
典型生态项目
LaTeX 构建管道
如果你将文档编译为 MultiMarkdown(即 File → Compile → Compile For → MultiMarkdown
),可以使用项目中包含的 Makefile
进一步处理生成的 MMD 文件,通过 pdflatex
生成 PDF。这提供了对样式定制的更大控制。
相关项目
- Scrivener:核心写作应用程序。
- Git:版本控制系统。
- MultiMarkdown:文档编译格式。
- pdflatex:LaTeX 编译器,用于生成 PDF。
通过这些工具和项目的结合,可以高效地管理和编写长篇作品。