1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-06-08 00:06:19 +02:00

Expand description of --single option in README.md

This commit is contained in:
Elisabeth Henry 2016-09-09 22:51:47 +02:00
parent 56aeaa3d72
commit 3785aeaaeb

View File

@ -144,7 +144,23 @@ title: My title
```
This is mostly useful when Crowbook is runned with the `--single`
argument (receiving a single Markdown file instead of a book configuration file).
argument (receiving a single Markdown file instead of a book
configuration file). E.g., the following Markdown file:
```
---
author: John Doe
title: A book
output.html: book.html
---
This is a very tiny book!
```
can be processed with `crowbook --single foo.md` or `crowbook -s
foo.md` to produce the `book.html` file. This is useful for short
texts that typically only contain one "chapter".
### Bugs ###