Converts books written in Markdown to HTML, LaTeX/PDF and EPUB

Related tags

PDF Files Processing html markdown rust pdf latex book epub
Overview

Crowbook

Travis status Appveyor status

Crowbook's aim is to allow you to write a book in Markdown without worrying about formatting or typography, and let the program generate HTML, PDF and EPUB output for you. Its focus is novels and fiction, and the default settings should (hopefully) generate readable books with correct typography without requiring you to worry about it.

Example

To see what Crowbook's output looks like, you can read the Crowbook guide rendered in HTML, PDF or EPUB.

You can also play with the online demo version.

Installing

There are two ways to install Crowbook: either using precompiled binaries, or compiling it using cargo.

Binaries

See the releases page to download a precompiled binary for your architecture (currently: Linux, Windows and MacOSX). Just extract the archive and run crowbook (or crowbook.exe on Windows). You might also want to copy the binary somewhere in your PATH for later usage.

If you are on Debian GNU/Linux or Ubuntu (on a PC architecture), you can also download .deb packages on the releases page.

Using Cargo

Cargo is the package manager for Rust. You can install it here. Once that is done:

$ cargo install crowbook

will automatically download the latest crowbook release on crates.io, compile it, and install it on your system.

Some dependencies also require building C libraries; you might thus also need to install a C compiler and make/cmake build tools. You can also try to build a version of Crowbook without optional features: cargo install crowbook --no-default-features --features "clap" will disable syntactic highlighting and proofreading, requiring less dependencies.

Dependencies

While there should be, strictly speaking, no real dependencies to be able to run Crowbook (it is published as a statically compiled binary), some features require additional commands to work correctly:

  • EPUB rendering requires the zip command to be present on your system;
  • PDF rendering requires a working installation of LaTeX (preferably xelatex).

Quick tour

The simplest command is:

$ crowbook <BOOK>

where BOOK is a configuration file. Crowbook will parse this file and generate HTML, EPUB, and/or PDF output formats, according to the settings in the configuration file.

To create a new book, assuming you have a list of Markdown files, you can generate a template configuration file with the --create argument:

$ crowbook my.book --create chapter_*.md

This will generate a default my.book file, which you'll need to complete. This configuration file contains some metadata, options, and lists the Markdown files.

For short books containing only a single Markdown file, it is possible to embed some metadata at the beginning of the file and use the --single or -s option to run crowbook directly on this Markdown file and avoid creating a separate book configuration file:

$ crowbook -s text.md

For more information, see the chapters on the arguments supported by crowbook and on the configuration file.

Current features

Output formats

Crowbook supports HTML, PDF and EPUB (either version 2 or 3) as output formats. See the Crowbook User Guide rendered in HTML, EPUB and PDF.

Input format

Crowbook uses pulldown-cmark and thus should support most of CommonMark Markdown. Inline HTML, however, is not implemented, and probably won't be, as the goal is to have books that can also be generated in PDF (and maybe ODT).

Typographic "cleaning"

Maybe the most specific "feature" of Crowbook is that it does its best to "clean" the input text before rendering it. By default, it removes superfluous spaces and tries to use curly quotes. If the book's language is set to french, it also tries to respect french typography by replacing spaces with non-breaking ones when it is appropriate (e.g. before '?', '!', ';' or ':').

Please open an issue describing typographic rules if you want them to be implemented for other languages.

Links handling

Crowbook tries to correctly translate local links in the input Markdown files: e.g. if you have a link to a Markdown file that is part of your book, it will be transformed into a link inside the document.

Inline YAML blocks

Crowbook supports inline YAML blocks:

---
author: Me
title: My title
---

This is mostly useful when Crowbook is run with the --single argument (receiving a single Markdown file instead of a book configuration file), for short texts that only contain one "chapter".

Proofreading

Crowbook can also generate "proofreading" copies in HTML or PDF, highlighting grammar errors and repetitions. For more information, see the proofreading chapter of the guide.

Interactive fiction

Crowbook has experimental support for writing interactive fiction (only for HTML). For more information, read the interactive fiction chapter.

Customization

While the default settings will hopefully generate something that should look "good enough", it is possible to customize the output, essentially by providing different templates.

Bugs

See the issue tracker on GitHub.

Contributors

Acknowledgements

Besides the Rust compiler and standard library, Crowbook uses the following libraries: pulldown-cmark, yaml-rust, mustache, clap, chrono, uuid, mime_guess, crossbeam, walkdir, rustc-serialize, caribon, hyper, url, lazy_static, regex, term, numerals, syntect.

It can also embed Highlight.js in HTML output to enable syntax highlighting for code blocks.

It also uses configuration files from rust-everywhere to use Travis and Appveyor to generate binaries for various platforms on each release.

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

Also, the W3C HTML validator and the IDPF EPUB validator proved to be very useful during development and testing.

ChangeLog

See ChangeLog.

Contributing

See how you can contribute to Crowbook.

If you find this project useful, you can also support its author by making a Paypal donation.

Library

While the main purpose of Crowbook is to be run as a standalone program, the code is written as a library, so if you want to build on it you can use it as such. You can look at the generated documentation on docs.rs.

Note that, in order to facilitate code reuse, some features have been split to separate libraries:

  • epub-builder makes it easier to generate EPUB files.
  • crowbook-text-processing contains all the "typographic" functions (smart quotes, handling of non-breaking spaces in french, ...).
  • crowbook-intl is used for the internationalization (translation) process.

License

Crowbook is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (LGPL), version 2.1 or (at your option) any later version. See LICENSE for more information.

Crowbook's logo is licensed under the Creative Commons Attribution 4.0 International license, based on the Rust logo by Mozilla Corporation.

Crowbook includes binary (minified) CSS and Javascript files from Highlight.js, written by Ivan Sagalaev, see license

Comments
  • Add an HTML renderer that generates multiple files

    Add an HTML renderer that generates multiple files

    Currently, the only HTML renderer (besides EPUB, which is technically HTML too) generates a standalone file. For long texts, it might make more sense to give the possibillity to generate a multiple file, probably in a directory with one file by chapter. This could be an additonal option output.html_dir that would operate in a similar manner to the EPUB renderer: generate one file by chapter in this directory, generate a CSS files and copy linked images in this directory.

    enhancement 
    opened by lise-henry 9
  • Compatibility with Jekyll: where to find images (and other files) ?

    Compatibility with Jekyll: where to find images (and other files) ?

    I just get this problem with images, but I suspect this will occur with all others files. First, let me show you the directory structures of jekyll. Most of the MD files are stored in the directory _posts and that's main content of the website. Inside those files, relative URL are supposed to be relative to the top of the website. Images are usually stored elsewhere, as the _posts directory will not be published as it is. So let's say that images are stored in the img directory. So, we have this structure:

    /
  _posts/
     my-first-short-story.md
     my-second-short-story.md
  img/
    beautiful.png
    ugly.png

    So, in my-first-short-story.md, I have a image linked in markdown this way: ![Ugly...](img/ugly.png) No problem for Jekyll. But Crowbook is not able to find the file when converting my-first-short-story.md. I suspect this to affect any relative URL.

    A solution may be to add an option to set the root to start with when using relative url, something like the base href directive in HTML.

    opened by taophp 8
  • Short story format ?

    Short story format ?

    I may use crowbook to format some short stories, with only one md file, so it should be great to have a option to change the output to something adapted : there is only one chapter, one title for both the book and the chapter, no numbering and no blank page to start with.

    opened by taophp 8
  • Improving readability for the HTML output format

    Improving readability for the HTML output format

    I start to work on the HTML format, and I suggest some changes on the style that should improve readability. The main change is to limit the width of the p element to 33em so the maximum length of a line should be nearly 66 characters, which seems to be the best width for the main content of the page (don't remember exactly where I get this, may be on The Elements of Typographic Style Applied to the Web (recommended reading), but, in any case, I strongly agree).

    Additionally, this change avoid a annoying effect of the current design (until the window is large enough): when the menu changes state (visible or not), the vertical position of the page is moving due to the width of the content, which changes with the menu. This effect occurs in another: window resizing. With the new style, this effect is avoid until the window get too thin.

    BTW: I made the change in this file as it seems to me that it's the only one used only for the HTML output. I may be wrong. Correct me if required.

    opened by taophp 7
  • Code syntax highlighting breaks after comments

    Code syntax highlighting breaks after comments

    Code syntax highlighting breaks for me after comments. This is reproducible with other languages.

    Using the latest binary from the releases for mac, crowbook-v0.14.0-x86_64-apple-darwin.

    image bug 
    opened by jrappen 5
  • Add option to generate `stdpage` output.

    Add option to generate `stdpage` output.

    Add an option to the latex template, to generate stdpages with fixed size typewriter font and 60 lines per page and extra wide annotation border. This is the standard for sending drafts to lectors (at least in germany).

    There's a latex package here which is overriding all styles by just including something like this in the header:

    \usepackage[hyphen=false,parskip]{stdpage}

    I think it can be easily included as option for the latex template, I can send you a PR, if you think this is good feature?

    opened by hirschenberger 5
  • HTML: Paragraphs to use unique numbered id

    HTML: Paragraphs to use unique numbered id

    I was thinking about what I should need to make the HTML output of Crowbook to remember the last vertical position when the user leaves the page and restore it when he comes back, even if the window has another size. It can be done purely with JavaScript, but there a part that would be better done when Crowbook output the HTML, and that's my request.

    I would like you to add a unique id to each paragraph. Numbering is not required, but it should be easier for you. I suggest something like cXXpYY where XX is the chapter number, and YY the paragraph number. So we'll have something like:

    <p id="c1p1">blabla</p>
<p id="c1p2">blabla</p>
<p id="c1p3">and so on...</p>

    Currently, I do not know when I will have enough time to write the JavaScript part, so I made this request first, in the hope to make this feature implementation progress faster.

    opened by taophp 5
  • Page numbers offset in TOC by -10

    Page numbers offset in TOC by -10

    Page numbers are offset in TOC by -10.

    Image 1 (click to reveal) image
    Image 2 (click to reveal) image

    Side note: Although the images here show the use of a custom LaTeX template, I can reproduce this with the LaTeX template shipping with crowbook.

    XeTeX    : 3.14159265-2.6-0.999991 (TeX Live 2019)
crowbook : v0.15.0
OS       : macOS Catalina 10.15.2 (19C57)
hardware : MBP 15" 2018, i9 2.9GHz, 32GB, 1TB, Radeon Pro 560X
    bug 
    opened by jrappen 4
  • Builds binaries for targets other than Linux/x86

    Builds binaries for targets other than Linux/x86

    Currently, I am unable to build binaries for other targets than Linux. In the past, I used trust to build and deploy binaries using Travis and Appveyor but I have been unable/incompetent to do it for the past few releases.

    So if someone understands these platforms better than me (that's not hard ^^) and has any idea how to fix the appveyor.yml/.travis.yml files and/or what I need to do on these sites I'd be more than happy :)

    Logs on travis (it doesn't even build there anymore because of syntect?) : https://travis-ci.org/lise-henry/crowbook Logs on appveyor: https://ci.appveyor.com/project/lise-henry/crowbook (here it builds correctly but i am incapable of deploying: https://ci.appveyor.com/project/lise-henry/crowbook/deployment/2575742)

    opened by lise-henry 4
  • Inline code is getting truncated

    Inline code is getting truncated

    Fantastic project! I'm working on converting a book that we had previously written in InDesign back to markdown, and it looks like the default PDF formatting is resulting in incorrect layout:

    screen shot 2017-09-29 at 9 01 25 am

    Here's the example paragraph in the screenshot if you want to test this:

    A good way to think about the difference between this method and `didUpdateComponent` is that `didMount` is an opportunity for configuration of the **view**, while `didUpdateComponent` and `initWithComponent:` is about configuring the **controller itself**. The one major exception is that `initWithComponent:` is called on a background thread, so it’s common to wait for the first mounting to complete configuration that had to be done on the main thread. This is something we’d like to fix.
    opened by ocrickard 4
  • Jekyll compatibility ?

    Jekyll compatibility ?

    As I use markdown first to publish my texts using Jekyll, my markdown files are builds the Jekyll way. So they have a YALM header. At least, I expect Crowbook to ignore them, so I would not have to manage two versions of each text. But this is not the case, and the result is ugly.

    Suggestion: it should be even better if the YAML header could be use by crowbook instead of an external configuration file. Maybe a YAML key named crowbook should be use to avoid conflict of key naming between Jekyll and Crowbook. So the file header should look like:

    
---
layout: post
title:  Disparition
date: 2016-01-18 00:30:05
categories: blog
type: nouvelle
crowbook:
  title: Disparition
  author: Stéphane Mourey
  lang: fr

---
And now, for your pleasure, a brand new history....

    Suggestion 2: there should be some redundant keys, like the title one in my sample. So, may crowbook read the whole YAML to get them, instead of repeating them in the file. I don't know, just thinking.

    opened by taophp 4
  • [Question] How to add license to a single file book?

    [Question] How to add license to a single file book?

    I have a short story so it doesn't have chapters. I'm generating the pdf and epub using the -s flag. I want to add the license of the text to both format but I can't find my way though it :-/

    PDF: I've printed the tex.template, and see a redefinition of \maketitle but it is used only for book, I can't find the one used if it's not a book.

    EPUB: I've printed the template using the command on the doc, but can't see how to add the license on the title page

    Also, what's the autograph metadata? It was added without documentation :)

    opened by Geobert 0
  • TOC of guide.book is inconsistent in html/epub

    TOC of guide.book is inconsistent in html/epub

    TOC entries with children will have their HTML tags escaped (e.g. instead of 2.10 <code> --to</code> it will be 2.10 &lt;code&gt--to&lt/code&gt;) while others (e.g. 2.9. <code>--verbose</code>) are unchanged.

    I think the inconsistency was already fixed upstream (see lise-henry/epub-builder#25) but there has not been a release of a new version. (Also I'm not sure if we really want HTML tags escaped in the TOC.)

    Downgrading the epub-builder crate from "0.5" to "0.4" fixes this behavior.

    opened by stefan0xC 0
  • Support mdBook-specific features: `#include` and `#rustdoc_include`

    Support mdBook-specific features: `#include` and `#rustdoc_include`

    Hi, Thanks for the great work! While I'm creating The Rust Programming Language epub from https://github.com/rust-lang/book.git found that some mdBook-specific features like #include and #rustdoc_include were not supported, can you add these features? Or any work around? Thanks again.

    opened by hustcer 2
  • Is this project dead? :/

    Is this project dead? :/

    Would it be possible, to give the maximum rights to some of the people that contributed to this project so far? Looking at the pull-requests, I see there are some candidates; maybe @hirschenberger and @jrappen? I would add at least 2, better more. In any case, it is unlikely they will do something really bad, and it can't be much worse then a dead projects, which is what this looks like now.

    opened by hoijui 6
  • Equations are not printed in the pdf

    Equations are not printed in the pdf

    have a MarkDown with equations but none are printed in the pdf or html they only appear in txt format. The template file puts the package for Xelatex but it doesn't work, you had any idea.

    ``

    opened by jacometoss 0
Releases(v0.15.2e)

  • v0.15.2e(Jul 7, 2020)

  • v0.15.2(Jul 6, 2020)

  • v0.15.1(Jul 6, 2020)

    • html.css.colours has been renamed html.css.colors
    • Fixed issue with table of contents page numbers in PDF output
    • Fixed issue with invalid XHTML in EPUB when using description terms
    • Fixed left/right margins in LaTeX (which were reversed)
    • LaTeX outputs of french documents now use enspaces and narrow non-breaking spaces
    • New option:
      • tex:escape_nb_spaces defaults to true and will uses TeX codes to display non-breaking spaces.
    Source code(tar.gz)
    Source code(zip)

  • v0.15.0(Jul 18, 2019)

    • Moved from pulldown-cmark to comrak for parsing Markdown. This may have some performances drawbacks but allows for a few more features:
      • Description lists
      • Strikethrough
      • Task items
    • New option:
      • crowbook.files_mean_chapters allow to enforce that each files means a chapter break or to make sure that it doesn't (by default, only true for numbered chapters).
    • Fallback on Rust zip library when there is no zip command.
    • By default, don't add an empty chapter title for non numbered "chapters" that don't contain a title.
    • Now uses reqwest instead of hyper to connect to languagetool/grammalecte.
    • hyphenation dependency is now optional.
    • Dependencies update.
    • Fix type deduction issues for new rustc compliler
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.15.0-1_amd64.deb(3.58 MB)
    crowbook_0.15.0_x86_linux.tar.gz(5.03 MB)

  • v0.14.1(Jun 1, 2018)

  • v0.14.0(Nov 26, 2017)

    • New option:
      • autograph is an autograph added after title.
    • User interface:
      • new argument --autograph prompts for an autograph.
      • --list-options and --stats now use colours if available.
      • options description with --list-options are now wrapped.
    • Bugfixes:
      • Preserve errors/warnings order with fancy UI.
      • Clean secondary bar when there is an error instead of hanging the UI.
      • LaTeX: fancy headers only applies to fancy pages (not chapter pages).
    Source code(tar.gz)
    Source code(zip)
    crowbook-v0.14.0-i686-apple-darwin.tar.gz(2.78 MB)
    crowbook-v0.14.0-i686-pc-windows-gnu.zip(2.44 MB)
    crowbook-v0.14.0-i686-unknown-freebsd.tar.gz(3.53 MB)
    crowbook-v0.14.0-i686-unknown-linux-gnu.tar.gz(3.53 MB)
    crowbook-v0.14.0-x86_64-apple-darwin.tar.gz(2.84 MB)
    crowbook-v0.14.0-x86_64-pc-windows-gnu.zip(2.32 MB)
    crowbook-v0.14.0-x86_64-unknown-linux-gnu.tar.gz(3.51 MB)
    crowbook_0.14.0-1_amd64.deb(1.79 MB)

  • v0.14.0-beta(Oct 8, 2017)

    • Bugfixes:
      • EPUB: escape quotes in content.opf.
      • LaTeX/PDF: allow hyphenations in typewriter font.
    • User interface:
      • User interface is quite fancier, with progress bars and all
      • Debug/warning/info levels should be displayed in a more coherent manner
      • New --no-fancy option if you don't like the fancy UI (or if it doesn't work in your terminal)
      • New --force-emoji option to force emoji usage.
    • Library interface:
      • Removed Book::set_verbosity method (uses a logger library instead).
    • Now requires rustc >= 1.20.0
    Source code(tar.gz)
    Source code(zip)
    crowbook_v0.14.0-beta_x86_64-apple-darwin.tar.gz(2.59 MB)

  • v0.13.0(Jul 14, 2017)

    • Breaking changes:
      • The template.tex template was quite modified. Crowbook now uses custom command for most markdown elements, defined in the template. This allow an user to redefine the way the book is rendered without having to modify Crowbook itself. Unfortunately, as tex templates for previous Crowbook versions won't work anymore.
      • the resources.files option is now a YAML list of strings, instead of a comma-seprated string.
    • Add support for grammalecte grammar checker.
    • crowbook command takes a new argument, -S or --stats which displays stats on the book (currently, words and characters count).
    • Interactive fiction:
      • Added conditional blocks.
    • Options:
      • output.xxx options can now take the "auto" value, which will infer the output file name based on the book file name.
      • output is a new option that can specify a series of format to render, with default output file name.
      • proofread.grammalecte and proofread.grammalecte.port allow respectively to enable grammar checking with Grammalecte and (optionnally) to specify the port to connect.
      • tex.margin.left, tex.margin.right, tex.margin.bottom and tex.margin.top are new options that allow to specify margins for LaTeX/PDF outputs.
      • tex.paper_size was renamed tex.paper_size.
    • HTML:
      • Add JSON-LD structured data to the book's HTML files.
    • Bugfixes:
      • LaTeX: fix rendering of part/chapter (part previously displayed as chapter and its first chapter as part)
      • EPUB:
        • Fix .rule so it is centered despite KOBO CSS injection.
      • Fix resources/images inclusion when they are symlinks to the actual file.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.13.0-1_amd64.deb(1.75 MB)
    crowbook_0.13.0_x86_64-apple-darwin.tar.gz(2.51 MB)
    crowbook_0.13.0_x86_64_linux.tar.gz(3.45 MB)

  • v0.12.0(Jun 5, 2017)

    This release includes a few new features, such as the possiblity to include Markdown files as section/subsections and not only as chapter, experimental support for superscript and subscript, and yet more experimental support for writing interactive fiction.

    • Book configuration file:
      • It is now possible to include subchapters using the -- command (with one dash per sublevel: --- foo.md will include foo.md as a subsection).
    • Markdown:
      • Added support for superscript and subscript features, using respectively foo^up^ or bar~down~ syntax.
    • New options:
      • rendering.chapter: change what is displayed in place of "chapter".
      • rendering.part: change what is displayed in place of "part".
      • html.chapter.template and html.part.template allow to tune a little how the chapters and parts are displayed in HTML.
      • tex.hyperref, if set to false, will disable hyperrefs for local links. Can be useful for some files.
      • crowbook.html_as_text, if set to false, will not treat HTML as text but ignore it.
      • subtitle, as its name suggest, set the subtitle of a book.
      • crowbook.markdown.superscript can enable or disable superscript/subscript "extension".
    • Rendering:
      • Change the way chapters are displayed by default.
      • PDF output now has a better-looking (hopefully) title page.
      • Internal links are a bit more flexible, e.g. if you link to Readme.html it will now try to link to the chapter corresponding to Readme.md.
    • Bugfixes:
      • LaTeX:
        • Fix bug in syntax highlighting.
        • Fix label placements (and thus navigation inside PDF document).
      • EPUB:
        • Add unnamed but numbered chapters to the TOC.
        • Fix HTML escaping issue for chapter titles.
        • Fix the way parts were handled in the TOC.
      • Book configuration file:
        • Fix issue when setting custom number for parts.
    • Crowbook now requires rustc >= 1.17.0
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.12.0-1_amd64.deb(1.73 MB)
    crowbook_0.12.0_x86_64_linux.tar.gz(3.41 MB)
    crowbook_v0.12.0_x86_64-apple-darwin.tar.gz(2.47 MB)

  • v0.11.4(Mar 21, 2017)

    • An image can now be considered standalone even if it is inside a link.
    • Bugfixes:
      • HTML/EPUB: use raw (not HTML rendered) metadata in the places where HTML code is not appropriate. Templates can use this metadata with the foo_raw value.
      • HTML/EPUB: fix double-escaping/rendering issues in titles.
      • EPUB:
        • Escape title and author before feeding them to epub-builder.
        • Fix content.opf issue by not rendering first chapter's title (marked as beginning of document) in <guide>.
    • Rendering:
      • HTML/EPUB: standalone images are now displayed centered.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.11.4-1_amd64.deb(1.75 MB)
    crowbook_0.11.4_i686_windows.zip(2.61 MB)
    crowbook_0.11.4_x86_64.linux.tar.gz(3.43 MB)
    crowbook_0.11.4_x86_64_windows.zip(2.52 MB)
    crowbook_v0.11.4-0_x86_64-apple-darwin.tar.gz(2.45 MB)

  • v0.11.3(Mar 19, 2017)

    • When crowbook parses the book's contents, it now detects which features are used. This is useful in various ways:
      • The ODT renderer only displays a global warning showing the lists of used features that are not implemented, instead of a warning each time such a feature is encountered.
      • The LaTeX and HTML/EPUB renderers only initialize syntect (which can take some time) if code blocks are used in the document.
      • The LaTeX renderer only requires LaTeX packages that are actually used in the document.
    • Command-line interface:
      • Warnings are now displayed by default.
      • The (undocumented) --debug argument has been removed.
      • The status of some messages have been modified ("warning" to "debug" or "error" to "warning").
    • Deprecated option:
      • crowbook.verbose has been deprecated, at it should be set by the CLI.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.11.1_x86_64_linux.tar.gz(3.39 MB)
    crowbook_0.11.3-1_amd64.deb(1.72 MB)

  • v0.11.2(Mar 5, 2017)

    • General:
      • When there is an error setting an option from the book configuration file (e.g. because it is an invalid key), print an error but do not abort, only ignore this specific option.
    • New options:
      • tex.stdpage: if set to true, will use the stdpage package to render the book according to standards for submitting manuscripts.
      • rendering.highlight.theme allows to specifies a theme for syntax highlighting (only used if rendering.highlight is set to "syntect").
      • html.highlight.theme, epub.highlight.theme and tex.highlight.theme allow to specify a theme for HTML/EPUB/LaTeX renderers (only used with syntect).
    • Deprecated option:
      • proofread.nb_spaces.
    • Rendering:
      • [syntect](https://crates.io/crates/syntect) is now the default for rendering.highlight. Concretely, this means that by default syntax highlighting is now done when crowbook is run instead of using [highlight.js](https://highlightjs.org/).
      • EPUB:
        • Now sets the "cover-image" property and meta so readers should display cover correctly.
        • Narrow non-breaking spaces should display more correctly on KOBO ereaders (hoping this won't break the way they are displayed everywhere else).
    • Proofreading:
      • Repetition detection is now a bit less of an hack, and should cause less problems when used in conjunction with grammar checking. It now also works on PDF output (so the way it is highlighted could be improved).
    • Bugfixes:
      • Fix mimetype of EPUB files (make sure it is always "stored" and not "deflated" by the zip command).
      • Avoid initializing syntect (at the cost of performances) if it is not used.
      • Avoid creating an empty file if some book renderer fails (e.g. EPUB or ODT because zip command is not present).
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.11.2-1_amd64.deb(1.63 MB)
    crowbook_0.11.2_i686_windows.zip(2.55 MB)
    crowbook_0.11.2_x86_64_linux.tar.gz(3.23 MB)
    crowbook_0.11.2_x86_64_windows.zip(2.39 MB)

  • v0.11.1(Jan 5, 2017)

    • Rendering:
      • Avoid page break before or after a separating rule.
      • Add support for syntect for syntax highlighting. This is activated by setting rendering.highlight to syntect (see below).
      • EPUB:
        • Set back HTML escape of narrow non-breaking spaces to true by default (it caused problems on some readers, but cause much more serious one if false).
        • Add more information to guide/nav landmarks.
      • LaTeX/PDF:
        • Improve the way code blocks are displayed, using the mdframed package.
        • Try to reduce the issues of too long lines when using code and code blocks, by inserting \allowbreak{} directive after some characters (., /, _, ...).
        • Block quotes are now displayed in italics.
        • Tables now use tabularx, which allows to break too long lines (it still doesn't break pages, though).
    • New options:
      • rendering.highlight can be set to none, highlight.js (by default, enables syntax highlighting via Javascript, but only on HTML document) or syntect (doesn't necessitate javascript, and can work in EPUB or LaTeX, but more experimental at this point).
    • Deprecated options:
      • html.highlight_code (use rendering.highlight instead).
    • Bugfixes:
      • HTML (standalone): fix the template that contained invalid HTML code.
    Source code(tar.gz)
    Source code(zip)
    crowbook-0.11.1-x86_64-apple-darwin.tar.gz(2.22 MB)
    crowbook_0.11.0_i686_windows.zip(2.52 MB)
    crowbook_0.11.0_x86_64_windows.zip(2.36 MB)
    crowbook_0.11.1-1_amd64.deb(1.53 MB)
    crowbook_0.11.1_x86_64.tar.gz(2.79 MB)

  • v0.11.0(Dec 30, 2016)

    Substantial changes in this release, the more important one being support for parts!

    • Breaking changes: the API has undergone some breaking changes, hoping they will be the last ones for a while. API should now be more simple and consistent (?). This version contains also substantial options renaming (see below).
    • Crowbook now supports parts (above the "chapter" level), using the '@' character in the book configuration file.
    • Command-line interface:
      • Behaviour of --to should now be consistent for all output formats.
      • If --output is set to -, prints to stdout.
      • Conversely, if <BOOK> is set to -, reads from stdin.
      • Path specified by --output is now interpreted relatively to current directory (and not depending on where <BOOK> is or its options).
    • Rendering:
      • Chapters with no titles now have an empty title added (so it can at least display e.g. "Chapter X").
      • EPUB:
        • The toc.ncx file now displays links to "title" and (if set) "cover" (can be deactivated, see below).
        • The toc.ncx file now displays toc levels below chapter.
        • The table of contents is now displayed inline if rendering.inline_toc is set to true.
    • New options:
      • epub.toc.extras, set to true by default, will add links to the title and the cover (if it is set) in the table of contents.
      • epub.escape_nb_spaces, similar to html.escape_nb_spaces and set to false by default since at least Kobo reader don't seem to be able to understand the CSS to escape those nb spaces...
      • rendering.chapter.roman_numerals, if set to true, will display chapter numbers using roman numerals.
      • rendering.part.roman_numerals, if set to true (it is by default) will display part numbers using roman numerals.
      • rendering.part.template specifies the numbering scheme of parts.
      • rendering.part.reset_counter, if set to true (it is by default), resets chapter number to zero after a part.
    • Renamed options:
      • import_config renamed to import.
      • rendering.chapter_template renamed to rendering.chapter.template.
      • html_single.html renamed to html.standalone.template.
      • html_single.js renamed to html.standalone.js.
      • html_single.one_chapter renamed to html.standalone.one_chapter.
      • output.html_dir renamed to output.html.dir.
      • output.proofread.html_dir renamed to output.proofread.html.dir.
      • html_dir.index.html and html.dir.chapter.html have been merged and both renamed to html.dir.template.
      • tex.font_size renamed to tex.font.size.
    • Bugfixes:
      • EPUB:
        • Fix duplicate HTML escaping (resulting in e.g. "&" instead of "&").
      • HTML directory:
        • Fix panic when trying to generate html directory in "../xxx" (#23).
        • Fix "previous chapter" links that were not displayed when "html.header" was set.
      • HTML:
        • Fix the way initial letter is displayed if rendering.initials is true.
    • Internationalization:
      • Strings in generated Crowbook documents (such as "Table of contents", "Title", "Cover" and such) are now translated in spanish.
    Source code(tar.gz)
    Source code(zip)
    crowbook-v0.11.0-x86_64-apple-darwin.tar.gz(1.77 MB)
    crowbook_0.11.0-1_amd64.deb(1.17 MB)
    crowbook_0.11.0-1_i686.deb(1.27 MB)
    crowbook_0.11.0_i686_linux.tar.gz(2.45 MB)
    crowbook_0.11.0_i686_windows.zip(2.48 MB)
    crowbook_0.11.0_x86_64_linux.tar.gz(2.33 MB)
    crowbook_0.11.0_x86_64_windows.zip(2.33 MB)

  • v0.10.4(Dec 16, 2016)

    • New options:
      • tex.font_size specifies an optional font size (in pt) passed to the LaTeX class (must be 10, 11 or 12).
      • tex.title can be set to false to avoid rendering the title with \maketitle.
      • tex.paper_size specifies the paper size for PDF output.
      • tex.template.add, html.css.add and epub.css.addallow to specify inline LaTex or CSS code in the book configuration file that will be added respectively to tex.template.add, html.css.add and epub.css.add.
      • html.icon allows to specify the path of an icon for HTML documents.
    • Command-line interface:
      • Paths that are displayed should now be normalized, e.g. "foo/bar.pdf" instead of "baz/../foo/bar.pdf".
    • Rendering:
      • HTML:
        • The default CSS style has been slightly modified.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.10.4-1_amd64.deb(1.13 MB)
    crowbook_0.10.4-1_i686.deb(1.24 MB)
    crowbook_0.10.4_i686_linux.tar.gz(2.09 MB)
    crowbook_0.10.4_x86_64_apple-darwin.tar.gz(1.68 MB)
    crowbook_0.10.4_x86_64_linux.tar.gz(1.95 MB)

  • v0.10.3(Nov 19, 2016)

    • Building:
      • Crowbook now requires rustc >= 1.13.0 to build.
      • Pre-built binaries now all include the proofreading feature.
      • Linux binaries are now linked against musl library so they should really work on any Linux platform.
    • Bugfixes:
      • Fixed escaping of author and title fields.
      • Fixed text cleaning in ODT rendering that causes corrupt files to be generated.
    • CommandLine Interface:
      • Crowbook displays clearer error messages when unable to launch latex or zip commands.
      • Crowbook uses term library in order to display colours correctly on e.g. Windows.
      • The new argument --lang (or -L) allows to set the runtime language used by Crowbook, overriding LANG environment variable.
      • --list-options no longer uses colours as it caused problems depending on the terminal or when piping to less.
    Source code(tar.gz)
    Source code(zip)
    crowbook-v0.10.3-x86_64-apple-darwin.tar.gz(1.67 MB)
    crowbook_0.10.3_linux_amd64.deb(1.13 MB)
    crowbook_0.10.3_linux_i686.deb(1.23 MB)
    crowbook_0.10.3_linux_i686.tar.gz(2.07 MB)
    crowbook_0.10.3_linux_x86_64.tar.gz(1.94 MB)
    crowbook_0.10.3_windows_i686.zip(2.45 MB)
    crowbook_0.10.3_windows_x86_64.zip(2.29 MB)

  • v0.10.2(Oct 21, 2016)

    Only minor changes in this version:

    • Options:
      • author and title's default values are both set to the empty string, instead of Anonymous and Untitled.
      • input.autoclean has been renamed input.clean.
      • input.smart_quotes has been renamed input.clean.smart_quotes.
      • new option: input.clean.ligature.dashes will (if set to true) replace -- to en dash (–) and --- to em dash (—).
      • new option: input.clean.ligature.guillemets will (if set to true) replace << and >> to french guillemets (« and »).
    • Rendering:
      • HTML: if html_single.one_chapter and rendering.inline_toc are both set to true, only render the TOC if currently displayed chapter is the first.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.10.2-1_amd64.deb(908.48 KB)
    crowbook_0.10.2-1_i686.deb(920.03 KB)
    crowbook_0.10.2_i686_windows.zip(2.06 MB)
    crowbook_0.10.2_linux_i686.tar.gz(1.50 MB)
    crowbook_0.10.2_linux_x86_64.tar.gz(1.42 MB)
    crowbook_0.10.2_x86_64-windows.zip(2.02 MB)

  • v0.10.1(Oct 17, 2016)

  • v0.10.0(Oct 17, 2016)

    This release contains some breaking changes (mostly for the API, which has been split in separate libraries). It alse features some internationalization support, and the program should now be tranlated if your LANG environment variable is set to french.

    • Breaking changes:
      • Templates:
        • Conditional inclusion depending on lang must now be done using lang_LANG (e.g. lang_fr, lang_en, and so on). This might impact custom epub.css and html.css templates.
      • API:
        • The escape module has been moved to a separate crate, crowbook_text_processing. The cleaner module is no longer public, but the features it provided are also available in crowbook_text_processing.
    • New options:
      • html.css.colours allows to provide a CSS file that only redefine the colour scheme. Such a file can be built from crowbook --print-template html.css.colours.
      • input.smart_quotes: if set to true, tries to replace ' and " by curly quotes.
    • Command line interface:
      • Crowbook is now (imperfectly) localized in french, and can be translated to other languages.
      • Added the --quiet (or -q) argument, that makes crowbook run without displaying any messages (except some error messages at this point).
    • Rendering:
      • HTML:
        • The table of contents menu is no longer displayed in the HTML single renderer if it doesn't contain at least two elements.
        • The default colour theme has been modified a little.
    • Bugfixes:
      • Fix the escaping of non-breaking spaces in EPUB, as &nbsp; and its friends aren't valid entities in XHTML, apparently.
    Source code(tar.gz)
    Source code(zip)
    crowbook-v0.10.0-x86_64-apple-darwin.tar.gz(1.26 MB)
    crowbook_0.10.0-1_amd64.deb(906.34 KB)
    crowbook_0.10.0-1_i686.deb(915.40 KB)
    crowbook_0.10.0_linux_i686.tar.gz(1.49 MB)
    crowbook_0.10.0_linux_x86_64.tar.gz(1.42 MB)
    crowbook_0.10.0_windows_i686.zip(1.08 MB)
    crowbook_0.10.0_windows_x86_64.zip(1.13 MB)

  • v0.9.1(Sep 29, 2016)

    This release mainly introduces generation of proofreading copies, allowing, if they are set (and crowbook was compiled with the proofread feature) to generate proofreading copies, using tools to check grammar and detect repetitions. These features are currently experimental.

    • New options:
      • html.escape_nb_spaces, if set to true (by default), will replace unicode non breaking spaces with HTML entites and CSS so it can display correctly even if reader's don't have a browser/font supporting these unicode symbols.
      • Output files for proofread documents: output.proofread.html, output.proofread.html_dir and output.proofread.pdf.
      • Proofread options proofread.repetitions and proofread.nb_spaces have been added.
        • proofread.nb_spaces, if set to true, highlights non-breaking spaces so it is easier to check the correct typography of a book. Note that it requires that html.escape_nb_spaces be set to true (default) to work.
        • proofread.reppetitions, if set to true, uses Caribon to highlight repetitions in a document. It also uses the settings proofread.repetitions.fuzzy, proofread.repetitions.max_distance, proofread.repetitions.threshold, proofread.repetitions.fuzzy.threshold, proofread.repetitions.ignore_proper. Note that this feature is not built by default, you'll have to build crowbook with cargo build --release --features "repetitions".
    • New default settings for options:
      • tex.command is now xelatex by default.
    • Rendering:
      • LaTeX:
        • Add support for xelatex in the default template.
      • Improved french cleaner (see an article (in french) that talks about what it does).
    • Crowbook user guide: documentation has been updated to correctly reflect 0.9.x options.
    • API:
      • clap dependency is now optional, people who want to use Crowbook as a library should include it with crowbook = { version = "0.9", default-features = false }. (clap is still required to build a working binary).
    Source code(tar.gz)
    Source code(zip)
    crowbook-v0.9.1-x86_64-apple-darwin.tar.gz(1.10 MB)
    crowbook_0.9.1-1_amd64.deb(941.65 KB)
    crowbook_0.9.1-1_i686.deb(990.72 KB)
    crowbook_0.9.1_linux_i686.tar.gz(1.69 MB)
    crowbook_0.9.1_linux_x86_64.tar.gz(1.56 MB)

  • v0.9.0(Sep 23, 2016)

    The main objective of this release is to clean public interfaces, in order to limit breaking changes in the future. Ideally, all pre-1.0 releases should thus be 0.9.x. Concretely, this meant three things:

    • reducing the surface of Crowbook's library API;
    • cleaning options names
    • cleaning the names exported in templates and document them, in order not to break user-defined templates in future (non-breaking) releases. More detailed changes for this release:
    • Breaking change for users: removed tex.short option, replaced by a more generic tex.class (default being book). html.crowbook_link has also been removed.
    • Renamed options. Using the old name will print a deprecation warning but will still work for a while.
      • temp_dir -> crowbook.temp_dir
      • zip.command -> crowbook.zip.command
      • verbose -> crowbook.verbose
      • html.print_css -> html.css.print
      • html.display_chapter -> html_single.one_chapter
      • html.script -> html_single.js
      • numbering -> rendering.num_depth
      • numbering_template -> rendering.chapter_template
      • display_toc -> rendering.inline_toc
      • toc_name -> rendering.inline_toc.name
      • enable_yaml_blocks -> input.yaml_blocks
      • use_initials -> rendering.initials
      • autoclean -> input.autoclean
      • html_dir.css -> html.css (not really renamed, html_dir.css isactually removed as there is no point in having different CSS for standalone and multifile HTML rendering, is it?)
    • New options:
      • More metadata: license, version and date. These metadata are not treated by the renderers, but they are exported to the templates: {{{metadata}}} allows to access the content. If they are present, a has_metadata is also set to true, allowing to do something like {{{title}}} {{#has_version}}version {{{version}}} {{/has_version}}.
      • Yet more metadata: it is possible to add custom metadata by prefixing it with metadata.. They will then be accessible in the templates, with dots ('.') replaced by underscores ('_'). E.g., with metadata.foo: bar you can access it in your templates with {{{metadata_foo}}}.
      • output.base_path specifies a directory where the output files (set by output.FORMAT will be written.
      • resources.base_path.templates specifies where templates can be found.
    • Rendering:
      • Metadata can now contain Markdown and will be rendered by the renderers. This might not be a good idea for common fields (e.g. "title"), though. Use with caution.
      • rendering.inline_toc.name can use {{{loc_toc}}} to specify a localized name.
      • HTML:
        • html.top and hstml.footer are now considered as templates, so you can use some {{{metadata}}} in it.
        • Improved the way footnotes are displayed.
        • In standalone HTML, footnotes are rendered at the end of the document instead of at the end of the chapter, unless html_single.one_chapter is true.
      • LaTeX:
        • If tex.class is set to article, chapters will be displayed as \sections since article class doesn't handle chapters.
        • Except if tex.class is set to book, margins are now symmetrical.
        • LaTex template now uses version and date.
    • Bugfixes:
      • import_config only import options from another book file that are not equal to the default ones and that haven't already been set by the caller. E.g., author: foo then import_config: bar.book won't erase the author previously set.
      • import_config now correctly translates the imported book's paths.
    • Crowbook program:
      • Still working to improve error messages.
      • crowbook --list-options uses colours. This might hurt your eyes.
      • Display an error message when mustache can't compile a template, instead of panicking.
    • Internal/API:
      • Added static methods to Logger to allows displaying messages more easily/prettily.
      • Reduce pubic API's surface so less changes will need to be considered breaking in the future.
    Source code(tar.gz)
    Source code(zip)
    crowbook-v0.9.0-x86_64-apple-darwin.tar.gz(1.06 MB)
    crowbook_0.9.0-1_amd64.deb(749.43 KB)
    crowbook_0.9.0-1_i686.deb(711.49 KB)
    crowbook_0.9.0_linux_amd64.gz(1.20 MB)
    crowbook_0.9.0_linux_i686.gz(1.15 MB)
    crowbook_0.9.0_windows_i686.zip(834.48 KB)
    crowbook_0.9.0_windows_x86_64.zip(871.58 KB)

  • v0.8.0(Sep 19, 2016)

    This release adds support for syntax higlighting in code blocks, customized top and footer blocks for HTML rendering, and the special import_config option that allows to import options from another book file. It also provides (hopefully) better error messages.

    • New options:
      • import_configis not really an option, but allows to import another configuration file, useful if you share a same set of options between multiple books.
      • use_initials (set to false by default) makes Crowbook use initials ("lettrines") at start of each chapter. Support is still experimental.
      • html.highlight_code (set to true by default) allows syntax highlighting for code blocks, using highlight.js.
      • html.higlight.css and html.highlight.js can be used to provide other themes (default is default.css) and an highlight.js build that support other languages.
      • html.footer allows to specify custom footer. If not set, html.crowbook_link allows to disable "Generated by Crowbook" message.
      • html.top allows to specify a custom header that will be displayed at the top of HTML file(s).
    • Deprecated options:
      • side_notes has been renamed html.side_notes.
    • Crowbook program:
      • All output formats are now rendered concurrently.
      • Better error messages. Crowbook now tries to give more information when displaying an error, with the file name where a problem was found, and, in some cases, the line. It also tries to detect errors (such as files not found) sooner.
      • Some "warning" messages have also been "moved" to error messages, to make sure they are displayed even when crowbook isn't runned with --verbose.
    • Rendering:
      • Hidden chapter now produce empty \chapter*{} and <h1> in LaTeX and HTML. This allow to delimit a chapter break even if nothing is displayed.
    • Bugfixes:
      • Navigation menu of standalone HTML didn't include a call to javascript when html.display_chapter was set to true, meaning it didn't display the chapter correctly.
      • Implementations of Image and StandaloneImage were reversed in LaTeX.
      • StandaloneImage urls were not adjusted (meanning that running crowbook from another directory failed).
      • Image paths are now found correctly in HtmlDir rendering even if crowbook is called from another directory (same fix as 0.6's for Epub and LaTeX, which was forgotten for HtmlDir).
    • Internal/API:
      • In order to have better error messages, there was a need to refactor the Error type, and make more methods return Result<X> instead of X. The API is, therefore, quite modified.
      • Added a Renderer trait used by the various renderers.
      • Removed some methods from public API.
    Source code(tar.gz)
    Source code(zip)
    crowbook-v0.8.0-x86_64-apple-darwin.tar.gz(992.75 KB)
    crowbook_0.8.0-1_amd64.deb(683.46 KB)
    crowbook_0.8.0-1_i686.deb(652.07 KB)
    crowbook_0.8.0_linux_amd64.tar.gz(1.10 MB)
    crowbook_0.8.0_linux_i686.tar.gz(1.06 MB)
    crowbook_0.8.0_windows_i686.zip(741.65 KB)
    crowbook_0.8.0_windows_x86_64.zip(774.29 KB)

  • v0.7.0(Sep 11, 2016)

    • Internal/API:
      • Token has a new variant, StandaloneImage. This is used to distinguish an image that is alone in a paragraph of an image that is inlined alongside text.
      • Parser.parse method now distingues between Image and StandaloneImage. Currently, an image is considered "standalone" if it is the sole element of a paragraph, even if it is among a link.
      • Token has a new is_image method.
    • Rendering:
      • Standalone images are now rendered differently than inline images (80% of width VS original size) in HTML/EPUB and LaTeX.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.7.0-1_amd64.deb(610.76 KB)
    crowbook_0.7.0-1_i686.deb(584.00 KB)
    crowbook_0.7.0_apple_x86_64.tar.gz(878.93 KB)
    crowbook_0.7.0_linux_amd64.tar.gz(1000.77 KB)
    crowbook_0.7.0_linux_i686.tar.gz(960.91 KB)
    crowbook_0.7.0_windows_i686.zip(642.20 KB)
    crowbook_0.7.0_windows_x86_64.zip(672.80 KB)

  • v0.6.0(Sep 9, 2016)

    • Deprecated options:
      • nb_char: since it was only used for french cleaner and for typography reasons it's better to use different non breaking spaces according to context, this option was not really useful anymore.
    • Rendering:
      • Images are now displayed at 80% width of the page.
    • Bugfixes:
      • Image paths are now found correctly in LaTeX and EPUB rendering even if crowbook is called from another directory.
      • Fixed a bug in French cleaner when a string to clean ended by a non-breaking space (space was doubled with a breaking one).
      • LaTeX/PDF:
        • "Autocleaning" is now also activated (for french at least) for LaTeX rendering, since it doesn't correctly insert non-breaking spaces for e.g. '«' or '»'.
        • Fixed escaping of -- to -{}- to avoid tex ligatures.
      • HTML/EPUB:
        • html.display_chapter now defaults to false (e.g., by default the HTML displays the entirety of a book).
        • Fixed rendering of lists when lang is set to fr.
        • Links are now HTML-escaped, fixing errors in XHTML (for EPUB rendering) when links contained '&' character.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.6.0-1_amd64.deb(609.86 KB)
    crowbook_0.6.0-1_i686.deb(583.21 KB)
    crowbook_0.6.0_apple_86_64.tar.gz(877.59 KB)
    crowbook_0.6.0_linux_i686.tar.gz(959.65 KB)
    crowbook_0.6.0_linux_x86_64.tar.gz(1000.08 KB)
    crowbook_0.6.0_windows_i686.zip(641.20 KB)
    crowbook_0.6.0_windows_x86_64.zip(671.88 KB)

  • v0.5.1(Apr 14, 2016)

    Mostly rendering fixes:

    • Epub:
      • Fix a validation problem when book contained hidden chapters.
    • French cleaner:
      • Use semi-cadratine space instead of cadratine space for dialogs.
      • Use non-narrow non-breaking spapce instead of narrow one for ':', '«' and '»' (following https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France).
    • HTML:
      • Add viewport meta tags.
      • Standalone HTML:
        • Don't display the button to display chapter and the previous/next chapter link if html.display_chapter is set to false.
        • Fix chapter displaying when some chapters are not numbered.
      • Multi-files HTML:
        • Fix previous/next chapter display to make it consistent with standalone HTML.
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.5.1-1_amd64.deb(626.08 KB)
    crowbook_0.5.1-1_i686.deb(583.55 KB)
    crowbook_0.5.1_apple_i686.tar.gz(857.23 KB)
    crowbook_0.5.1_apple_x86_64.tar.gz(894.00 KB)
    crowbook_0.5.1_linux_i686.tar.gz(968.86 KB)
    crowbook_0.5.1_linux_x86_64.tar.gz(1.00 MB)
    crowbook_0.5.1_windows_i686.zip(617 bytes)
    crowbook_0.5.1_windows_x86_64.zip(619 bytes)

  • v0.5.0(Apr 2, 2016)

    • Crowbook now requires Rustc 1.7.0.
    • It is now possible to render HTML in multiple files:
      • output.html_dir will activate this renderer, and specify in which directory to render these files;
      • html_dir.css allows to override the CSS for this rendering;
      • html_dir.index.html allows to specify a template for the index.html page;
      • html_dir.chapter.html allows to specify a template for the chapters pages.
    • New book options:
      • tex.short: if set to true, the LaTeX renderer will use article instead of book as document class, and will use the default \maketitle command for article. This option is by default set to false, except when Crowbook is called with --single.
      • enable_yaml_blocks: parsing YAML blocks is no longer activated by default, except when using --single. This is because you might want to have e.g. multiple short stories using YAML blocks to set their titles and so on, and a separate .book file to render a book as a collection of short stories. In this case, you wouldn't want the displayed title or the output.pdf/html/epub files be redefined by the short stories .md files.
      • html.print_css: allows to specify a stylesheet for media print
      • html.display_chapter: displays one chapter at a time in standalone HTML
      • html.script: allows to specify a custom javascript file for standalone HTML
      • html_dir.script: same thing for multipage HTML
      • resources.base_path: by default, Crowbook resolves local links in markdown files relatively to the markdown file. This option allows to resolve them relatively to a base path. This option comes with two variants, resources.base_path.images and resources.base_path.links, which only activate it for respectively images tags and links tags. These two options are ignored when base_path is set. There is also resources.base_path.files which specify where additional files (see below) should be read, but this is one is set to . (i.e., the directory where the .book file is) by default.
      • resources.files: indicate a (whitespace-separated) list of files that should be embedded. Currently only used with the EPUB renderer.
      • resources.out_path: indicate where resources.files should be copied in the final document. Default to data, meaning that files will be placed in a data directory in the EPUB.
    • Rendering:
      • Templates can now use localized strings according to the lang option
      • Standalone HTML now includes locale files using base64.
      • Standalone HTML displays one chapter at a time, thouht it can be changed via a button in the menu.
      • HTML/EPUB: default CSS now uses the lang value do determine how to display lists (currently the only difference is it uses "–" when lang is set to "fr" and standard bullets for other languages).
    • Bugfixes:
      • Fixed a bug of filename "resolution" when Crowbook was called with --single (e.g., crowbook -s tests/test.md would previously try to load `tests/tests/test.md).
      • Epub renderer now uses the mime_guess library to guess the mime type based on extension, which should fix the mime type guessed for a wide range of extensions (e.g., svg).
    • Internal/API:
      • The Book::new, new_from_file, and new_from_markdown_file take an additional options parameter. To create a book with default options, set it to &[].
    Source code(tar.gz)
    Source code(zip)
    crowbook_0.5.0-1_amd64.deb(595.85 KB)
    crowbook_0.5.0-1_i686.deb(581.17 KB)
    crowbook_0.5.0_apple_i686.tar.gz(856.55 KB)
    crowbook_0.5.0_apple_x86_64.tar.gz(894.32 KB)
    crowbook_0.5.0_linux_i686.tar.gz(969.05 KB)
    crowbook_0.5.0_linux_x86_64.tar.gz(1.00 MB)
    crowbook_0.5.0_windows_i686.zip(507.57 KB)
    crowbook_0.5.0_windows_x86_64.zip(635.88 KB)

  • v0.4.0(Mar 1, 2016)

    • Crowbook now internally uses a true YAML parser, yaml_rust, for its options. Since the "old" Crowbooks's config format was similar, but had some subtle differences, this is somewhat of a breaking change:
      • strings should now be escaped with "" in some cases (e.g. if it contains special characters). On the other hand, it allows to optionally escape a string with these quotes, which wasn't possible until then and might be useful in some cases.
      • multiline strings now follow the YAML format, instead of the previous "YAML-ish" format. This can impact the way newlines are added at the end of a multiline string. See e.g. this link for the various ways to include mulitiline strings in Yaml.
    • Crowbook now parses YAML blocks (delimited by two lines with "---") in Markdown files, ignoring keys that it doesn't recognize. This allows crowbook to be compatible(-ish) with Markdown that contains YAML blocks for Jekyll or Pandoc.
    • New option --single allows to give Crowbook a single Markdown file (which can contain options within an inline YAML block) instead of a book configuration file. This is useful for e.g. short stories.
    • Enhanced the way debugging/warning/info messages are handled and displayed:
      • Added a --debug option to the binary.
      • Internal: added a Logger struct.
      • Different levels of information (debug/warning/info/error) get different colours.
    • Bugfixes:
      • Crowbook no longer crashes when called with the --to argument if it can't create a file.
    Source code(tar.gz)
    Source code(zip)
    crowbook-0.4.0-windows-i686.zip(462.54 KB)
    crowbook-0.4.0-windows-x86_64.zip(583.52 KB)
    crowbook-v0.4.0-i686-apple-darwin.tar.gz(750.46 KB)
    crowbook-v0.4.0-i686-unknown-linux-gnu.tar.gz(860.61 KB)
    crowbook-v0.4.0-x86_64-apple-darwin.tar.gz(780.13 KB)
    crowbook-v0.4.0-x86_64-unknown-linux-gnu.tar.gz(901.58 KB)
    crowbook_0.4.0-1_amd64.deb(517.94 KB)
    crowbook_0.4.0-1_i686.deb(517.97 KB)

  • v0.3.0(Feb 27, 2016)

    • Crowbook now tries to convert local links. That is, if you link to a Markdown file that is used in the book (e.g. README.md), it should link to an appropriate inner reference inside the book.
    • Latex renderer now supports (local) images.
    • Epub renderer now embed (local) images in the EPUB file.
    • Some changes to the HTML/Epub stylesheets.
    • Internal (or usage as a library):
      • Crowbook no longer changes current directory, which worked in the binary but could cause problem if library was used in multithreaded environment (e.g. in cargo test).
      • More modules and methods are now private.
      • Improved documentation.
      • Added more unit tests.
    • Bugfixes:
      • Epub renderer now correctly renders unnumbered chapter without a number in its toc.ncx file
    Source code(tar.gz)
    Source code(zip)
    crowbook-i686-windows.zip(379.79 KB)
    crowbook-v0.3.0-i686-apple-darwin.tar.gz(632.39 KB)
    crowbook-v0.3.0-i686-unknown-linux-gnu.tar.gz(743.29 KB)
    crowbook-v0.3.0-x86_64-apple-darwin.tar.gz(669.48 KB)
    crowbook-v0.3.0-x86_64-unknown-linux-gnu.tar.gz(784.97 KB)
    crowbook-x86_64-windows.zip(484.11 KB)

  • v0.2.2(Feb 25, 2016)

  • v0.2.1(Feb 25, 2016)

    • Bugfixes:
      • HTML/Epub rendering no longer incorrectly increment chapter count for unnumbered chapters,
      • Latex: makes what is possible to avoid orverflowing the page.
    • Minor changes:
    • Latex: improvement of the default way URLs are displayed
    Source code(tar.gz)
    Source code(zip)
    crowbook-0.2.1-i686-pc-windows.zip(372.67 KB)
    crowbook-0.2.1-x86_64-pc-windows.zip(473.32 KB)
    crowbook-v0.2.1-i686-apple-darwin.tar.gz(621.33 KB)
    crowbook-v0.2.1-i686-unknown-linux-gnu.tar.gz(732.31 KB)
    crowbook-v0.2.1-x86_64-apple-darwin.tar.gz(657.15 KB)
    crowbook-v0.2.1-x86_64-unknown-linux-gnu.tar.gz(773.35 KB)
Owner
Élisabeth Henry
Élisabeth Henry
GitHub
PDF command-line utils written in Rust

rpdf PDF command-line utils written in Rust. rpdf makes working with PDF annotions super easy! It can merge annotations from multiple files, some show

Jérome Eertmans 13 May 9, 2023
Generate PDF files with JavaScript and WASM (WebAssembly)

WASM-PDF Generates PDF files directly in the browser with JavaScript and WASM (WebAssembly). Idea here is to push all the work involved in creating a

Jussi Niinikoski 369 Jan 2, 2023
PDF Structure Viewer, This tool is useful for when working with PDFs and/or lopdf.

PDF Structure Viewer Inspect how the PDF's structure looks. This tool is useful for when working with PDFs and/or lopdf. This application is used lopd

Ralph Bisschops 13 Nov 21, 2022
Image cropper (and colorizer) for pdf scans

Image cropper for personal use (might not work with your pdfs) Requires pdfimages on the path to work properly It's thought just for my workflow so is

cdecompilador 2 Nov 7, 2022
Generating PDF files in pure Rust

pdf-canvas A pure rust library for generating PDF files. Currently, simple vector graphics and text set in the 14 built-in fonts are supported. To use

Rasmus Kaj 128 Jan 1, 2023
An easy-to-use library for writing PDF in Rust

printpdf printpdf is a library designed for creating printable PDF documents. Crates.io | Documentation [dependencies] printpdf = "0.3.2" Features Cur

Felix M. Schütt 592 Jan 8, 2023
A Rust library for PDF document manipulation.

lopdf A Rust library for PDF document manipulation. Example Code Create PDF document #[macro_use] extern crate lopdf; use lopdf::{Document, Object, St

Junfeng Liu 1.1k Dec 30, 2022
docx-you-want is a tool to convert a PDF document into a .docx file

ddocx-you-want is a tool to convert a PDF document into a .docx file ... in an unusual way. Since these two formats are inherently differ

null 45 Dec 23, 2022
A tool for creating code documentation and manuals for software/codefiles

Auto-Doc A tool, written in Rust, for creating code documentation and manuals for software/code files written in Python (for now) NOTE: This is the fi

Owen Hoglund 4 Oct 19, 2022
🏭 Convert Markdown documents into themed HTML pages with support for code syntax highlighting, LaTeX and Mermaid diagrams.

Marky Markdown Magician ?? Features Hot reload previewing ?? Conversion to HTML / PDF ?? Themes! ✨ Extensions - Math, diagrams, syntax-highlighting ??

Vadim 12 Feb 19, 2023
Crates.io library that provides high-level APIs for obtaining information on various entertainment media such as books, movies, comic books, anime, manga, and so on.

Crates.io library that provides high-level APIs for obtaining information on various entertainment media such as books, movies, comic books, anime, manga, and so on.

consumet-rs 5 Aug 13, 2023
mdBook is a utility to create modern online books from Markdown files.

Create book from markdown files. Like Gitbook but implemented in Rust

The Rust Programming Language 11.6k Jan 4, 2023
Make a PDF file by writing kind of like HTML and CSS.

markup-pdf-rs The Rust library for making a PDF files by writing kind of like HTML and CSS. Inspired by Satori and React-pdf. This library makes a PDF

null 9 Jan 10, 2023
Markdown to HTML converter written in Rust. Inspired by Katsuki Yuri's Makudaun Tool.

Makurust Makurust is a powerful tool written in Rust that allows you to effortlessly convert your Markdown files into static HTML pages. Inspired by T

Said (Fromgodd) 15 Apr 9, 2023
Tools - The Rome Toolchain. A linter, compiler, bundler, and more for JavaScript, TypeScript, HTML, Markdown, and CSS.

Rome is currently being rewritten in Rust. Read more about it in our latest blog post. The documentation below is out of date and available for poster

Rome 22k Jan 3, 2023
A Markdown to HTML compiler and Syntax Highlighter, built using Rust's pulldown-cmark and tree-sitter-highlight crates.

A blazingly fast( possibly the fastest) markdown to html parser and syntax highlighter built using Rust's pulldown-cmark and tree-sitter-highlight crate natively for Node's Foreign Function Interface.

Ben Wishovich 48 Nov 11, 2022
A Faster(⚡) formatter, linter, bundler, and more for JavaScript, TypeScript, JSON, HTML, Markdown, and CSS Lapce Plugin

Lapce Plugin for Rome Lapce-rome is a Lapce plugin for rome, The Rome is faster ⚡ , A formatter, linter, compiler, bundler, and more for JavaScript, T

xiaoxin 7 Dec 16, 2022
A lightweight, cross-platform epub reader.

Pend Pend is a program for reading EPUB files. Check out the web demo! Preview Image(s) Installation Building Pend is simple & easy. You should be abl

bx100 11 Oct 17, 2022
A simple (but really fast!) CLI tool to convert an epub into a text file.

epub_to_txt A simple (but really fast!) CLI tool written in Rust to convert an epub into a text file (in Markdown format). Usage epub_to_txt filename.

Darren Mothersele 3 Jul 30, 2023
A command-line tool for re-packaging an epub that has been unzipped. Can also be used as a library.

?? zaino A command-line tool for re-packaging an epub that has been unzipped. Can also be used as a library. Installation To use zaino as a library, a

Zachary Golba 3 Aug 17, 2023