mirror/crowbook
1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-09-28 15:21:33 +02:00
Code Issues
Converts books written in Markdown to HTML, LaTeX/PDF and EPUB
38 Commits 9 Branches 35 Tags 17 MiB
Rust 92.8%
CSS 2.3%
HTML 1.4%
JavaScript 1.4%
TeX 1.3%
Other 0.8%
763c3671e8
Go to file
Elisabeth Henry 763c3671e8 started using clap to parse arguments
2016-02-20 05:49:41 +01:00
book_example now supports epub3 (in theory) 2016-02-20 03:41:29 +01:00
src started using clap to parse arguments 2016-02-20 05:49:41 +01:00
templates updated readme.md and Cargo.toml 2016-02-20 04:49:20 +01:00
tests tests now compile again 2016-02-19 16:27:41 +01:00
.gitignore now supports epub3 (in theory) 2016-02-20 03:41:29 +01:00
.travis.yml initial commit 2016-02-18 04:06:14 +01:00
Bugs.md updated readme.md 2016-02-19 23:01:34 +01:00
Cargo.toml started using clap to parse arguments 2016-02-20 05:49:41 +01:00
LICENSE Initial commit 2016-02-18 04:02:59 +01:00
README.md updated readme.md and Cargo.toml 2016-02-20 04:49:20 +01:00

README.md

Crowbook

Yet another converter from Markdown to (HTML, LaTeX, Epub).

Build Status

Usage

$ crowbook some_file.book # or
$ cargo run some_file.book

Parse the config file and generate book in HTML, Epub and/or Latex/PDF (according to config file).

For more information see the book_example directory.

Features

Done

  • Support for some simple formatconfiguration files to list chapters and metadatas, so you just run crowbook some_file and you don't have to pass more options, it generates the rest.
  • Support for basic Markdown features useful in writing novels.
  • Support for Epub2 and Epub3 format as output.
  • Very basic support for LaTeX format as output, and PDF through it.
  • Support for HTML format as output.
  • Support for basic french typography in HTML/Epub format, and by that I mostly mean non-breaking spaces.
  • Decent default templates and CSS.
  • Some configuration for HTML/Epub templates and CSS.

ToDo

  • Real support for LaTeX.
  • Allow more customization.
  • Provide a binary which accepts some option and not just an input file.
  • Support for easily embedding custom fonts (and other files) in Epub/HTML.
  • Correct support for technical books.
  • Support for ODT as output format?

See also Bugs.

License

Currently, MIT but this might change.

Acknowledgements

Besides the Rust compiler and standard library, Crowbook uses the following libraries:

While Crowbook directly doesn't use them, there was also some inspiration from Pandoc and mdBook.