Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sile-typesetter/casile-demos
Example content demostrating the usage of the CaSILE toolkit.
https://github.com/sile-typesetter/casile-demos
casile publishing
Last synced: 2 months ago
JSON representation
Example content demostrating the usage of the CaSILE toolkit.
- Host: GitHub
- URL: https://github.com/sile-typesetter/casile-demos
- Owner: sile-typesetter
- License: unlicense
- Created: 2017-01-21T08:07:50.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T13:55:07.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T00:16:18.998Z (9 months ago)
- Topics: casile, publishing
- Language: Lua
- Size: 59.6 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CaSILE Demos
This repository is a showcase of things that can be done with [CaSILE][].
If you are just starting a new project and want to start with some minimal boiler plate, see the [CaSILE Template][casile-template] repository.
Once you get the ball rolling, come back here for more ideas on what you can do.
Think of this repository as if it was a book *series* project.
There are several sample "books" showing off various possible features.
This will show some samples of what it might look like to organize a book and its contents for publishing using [CaSILE][].
Get started by cloning this repository:
```sh
git clone https://github.com/alerque/casile-demos.git
cd casile-demos
casile setup
casile make
```
# A Very Simple Book
The presence of the two files `simple_book.md` and `simple_book.yml` together in the git repository are enough to convince CaSILE that you have a book project on your hands.
This book uses the default settings for this repository. At a mimimum:
* A project URL has been specified in the makefile.
* A matching pair of `.md` and `.yml` makes a book.
* The Markdown file has content and the YAML metadata defines a title.
Two additional settings beyond the minimum are setting a separate directory for finished products to land in (`PUBDIR`) and paring the expected output formats down to just *pdfs* and *epub* (by default all possible formats are generated).
You can build it with the default options like this:
```
make simple_book
```
The output of this should be a `pub` directory with a couple files such as `simple_book-a4-print.pdf` (note *a4* is the default paper size and *print* is the default binding layout) as well as `simple_book.epub`.
# A Slightly Fancier Book
It's possible to be a bit more creative with your source files. Because all Markdown is pre-processed you can use `m4` (or even a templating language of your choosing) to bring multiple sources together.
For example `fancy_book.md` doesn't actually have any content, it is just a placeholder that loads chapter files from a directory.
You can also directly build any arbitrary output:
```
make fancy_book-cep-paperback.pdf
```
[CaSILE]: https://github.com/alerque/casile
[casile-template]: https://github.com/alerque/casile-template