README

此工具可用于生成Leanpub书籍的样本文本。

安装

使用Composer安装。在Leanpub书籍项目的根目录（在manuscript/目录之上）添加一个composer.json文件。

{
    "require": {
        "matthiasnoback/leanpub-sampler": "~0.1"
    }
}

然后运行composer update。将创建一个vendor/目录，其中包含Leanpub样本及其依赖项。

首先，您需要编辑您的稿件文件并添加样本文本的标记

# A regular chapter

## A regular section

Some text.

%% begin sample

## A sample section

Some sample text.

%% end sample

然后运行

php vendor/bin/generate-sample.php

样本生成器将根据%% begin sample和%% end sample标记生成样本文本。它扫描manuscript/目录及其子目录中的所有.txt或.md文件。

结果是新的文件manuscript/sample-text.txt，其中包含所有样本文本。

使用命令行选项--all-sections或-s，您可以指示样本生成器自动将任何部分、章节或部分标题添加到样本文本中

php vendor/bin/generate-sample.php -s

这很有用，如果您想在生成的样本文件中保留原始的稿件结构。这也很有用，因为如果样本文件中包含所有部分、章节和部分标题，Leanpub将添加完整的目录到生成的预览文件中。

当Leanpub生成预览文件时，它会查看manuscript/Sample.txt文件。所有提到的文件都将添加到生成的预览文件中。确保您也将sample-text.txt文件添加到列表中。

manuscript/Sample.txt的内容应该是

sample-text.txt

Leanpub样本生成器按字母顺序扫描稿件文件。因此，为了保留初始顺序，最好也按字母顺序排序您的稿件文件，如

00-chapter1.txt
01-chapter2.txt
...