{"id":15539412,"url":"https://github.com/greatwizard/reliure","last_synced_at":"2025-04-23T16:20:54.639Z","repository":{"id":42721543,"uuid":"244159021","full_name":"GreatWizard/reliure","owner":"GreatWizard","description":"Bind your books for e-readers.","archived":false,"fork":false,"pushed_at":"2024-06-28T15:29:17.000Z","size":2488,"stargazers_count":5,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-09T12:51:26.400Z","etag":null,"topics":["bind","binding","book","bookbind","bookbinding","docx","ebook","ebooks","epub","hacktoberfest","kindle","kindlegen","latex","markdown","mobi","odt","pandoc","pdf","pdf-generation","reliure"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GreatWizard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-01T13:58:08.000Z","updated_at":"2024-09-12T20:36:29.000Z","dependencies_parsed_at":"2024-11-15T10:31:44.036Z","dependency_job_id":"a079661e-95cd-4dac-9ac7-5592e4f14482","html_url":"https://github.com/GreatWizard/reliure","commit_stats":{"total_commits":91,"total_committers":1,"mean_commits":91.0,"dds":0.0,"last_synced_commit":"6e5972d9c84b8f4d412bf674ff9941cb84e2b9c1"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatWizard%2Freliure","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatWizard%2Freliure/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatWizard%2Freliure/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatWizard%2Freliure/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GreatWizard","download_url":"https://codeload.github.com/GreatWizard/reliure/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250468277,"owners_count":21435454,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bind","binding","book","bookbind","bookbinding","docx","ebook","ebooks","epub","hacktoberfest","kindle","kindlegen","latex","markdown","mobi","odt","pandoc","pdf","pdf-generation","reliure"],"created_at":"2024-10-02T12:10:22.424Z","updated_at":"2025-04-23T16:20:54.600Z","avatar_url":"https://github.com/GreatWizard.png","language":"JavaScript","funding_links":["https://liberapay.com/GreatWizard/"],"categories":[],"sub_categories":[],"readme":"# Reliure\n\n[![Build Status](https://github.com/GreatWizard/reliure/actions/workflows/test.yml/badge.svg)](https://github.com/GreatWizard/reliure/actions?query=workflow%3Atest)\n[![License: GPL-3.0](https://img.shields.io/github/license/GreatWizard/reliure)](https://github.com/GreatWizard/reliure/blob/master/LICENSE.md)\n[![Liberapay](http://img.shields.io/liberapay/patrons/GreatWizard.svg?logo=liberapay)](https://liberapay.com/GreatWizard/)\n\nBind your books for e-readers.\n\n![Screenshot of Reliure running in a terminal](https://raw.githubusercontent.com/GreatWizard/reliure/master/reliure-screenshot.png)\n\n## Features\n\n- Compiles Microsoft Word DOCX, LibreOffice ODT, Markdown, LaTeX... files in epub, mobi and pdf\n- Cross-platform compatibility (Windows, Mac and Linux)\n- Configuration in a single file\n- Validate the configuration before creating the books\n- Replaces part of the configuration for a specific format\n- Supports custom fonts (ttf and otf)\n- Supports cover image\n- Supports metadata\n\n### Features only for ebooks (epub and mobi)\n\n- Supports custom metadata\n- Supports custom CSS\n- Supports automatic regexp substitutions\n\nℹ️ KindleGen does not work on 64-bit MacOS. On this platform, you can only compile in epub.\n\n## Prerequisites\n\nYou need to have on your computer:\n\n- Pandoc: https://pandoc.org/installing.html\n- MiKTeX: https://miktex.org/download\n\n## Installation\n\nThen, you can download the [latest release](https://github.com/GreatWizard/reliure/releases/latest) for your computer:\n\n- Windows: https://github.com/GreatWizard/reliure/releases/latest/download/reliure-win.exe\n- MacOS: https://github.com/GreatWizard/reliure/releases/latest/download/reliure-macos\n- Linux: https://github.com/GreatWizard/reliure/releases/latest/download/reliure-linux\n\n## Usage\n\n### Configuration file\n\nYour entry point is a configuration file named `reliure.yml`:\n\n```yaml\n# Name of the output file\nfilename: My Ebook\n\n# Default configuration applied to every format\ndefault:\n  # Cover image of the ebook\n  coverImage: cover.jpg\n  # Deactivate the default CSS (false by default) used by epub/mobi format\n  ignoreDefaultStyleSheet: true/false\n  # Custom Style sheets appends to the default stylesheet used by epub/mobi format\n  styleSheets:\n    - style.css\n  # Custom fonts configuration, files must be in the same directory\n  fonts:\n    main:\n      name: EB Garamond # Used to define the font name\n      baseFilename: EBGaramond # Used to find the files\n      extension: .otf # Supported format are ttf and otf\n      # Files are defined by shapes. It work like a \"mask\", \"*\" is replaced by the base filename of the font\n      shapes:\n        upright: '*-Regular' # EBGaramond-Regular.otf\n        italic: '*-Italic' # EBGaramond-Italic.otf\n  # Files used to build the ebook\n  files:\n    - my-ebook.docx\n\n  # Metadata following pandoc's options https://pandoc.org/MANUAL.html#epub-metadata\n  metadata:\n    title: Test Book\n    author: Guillaume Gérard\n    date: 2020-11\n    lang: fr-FR\n\n  # Extra metadata\n  extraMetadata:\n    'calibre:series': My Collection\n    'calibre:series_index': 1\n\n  # Example of substitutions for chapters, cover and title page files used by epub/mobi format\n  textSubstitutions:\n    - regex: \u003cp\u003e\\*{3}\u003c/p\u003e\n      replacement: \u003cp class=\"center\"\u003e***\u003c/p\u003e\n\n  # Example of substitutions for navigation file used by epub/mobi format\n  navSubstitutions:\n    - regex: \u003c!DOCTYPE html\u003e\n      replacement: \u003c!DOCTYPE html2\u003e\n\n  # Example of substitutions for the OPF file used by epub/mobi format\n  opfSubstitutions:\n    - regex: \u003cdc:language\u003efr-FR\u003c/dc:language\u003e\n      replacement: \u003cdc:language\u003efr-BE\u003c/dc:language\u003e\n\n# Overridden configuration for epub format\nepub:\n  metadata:\n    identifier: 'urn:isbn:1234567890123'\n    rights: 'ISBN: 123-4-5678901-2-3'\n\n# Overridden configuration for mobi format\nmobi:\n  coverImage: cover-mobi.jpg\n  metadata:\n    identifier: 'urn:isbn:1234567890145'\n    rights: 'ISBN: 123-4-5678901-4-5'\n\n# Overridden configuration for pdf format\npdf:\n  coverImage: ../cover-pdf.jpg\n  # fourth cover option is only used by pdf format\n  fourthCoverImage: ../fourth-cover-pdf.jpg\n  metadata:\n    identifier: 'urn:isbn:1234567890167'\n    rights: 'ISBN: 123-4-5678901-6-7'\n  # latex packages option is only used by pdf format\n  latexPackages:\n    - '[french]{babel}'\n```\n\n### Commands\n\nUsage: `reliure [options] [configuration file/directory]`\n\n#### Options:\n\n- `-c`, `--config`: The configuration file/directory to process\n- `--epub`: Specify to bound the epub format\n- `--mobi`: Specify to bound the mobi format and you accept the following terms of use: https://www.amazon.com/gp/feature.html?docId=1000599251\n- `--pdf`: Specify to bound the pdf format\n- `--kindlegen-path`: Specify the kindlegen location\n- `--non-interactive`: Does not prompt for any input\n- `-v`, `--version`: Print the version number\n- `-h`, `--help`: Print usage information\n\n#### Examples:\n\n```shell\nreliure --epub --mobi\nreliure --epub --pdf my-project/\nreliure --epub --pdf my-complex-project/reliure-config.yml\nreliure --mobi --kindlegen-path=/usr/local/bin/kindlegen my-project/reliure.yml\nreliure -v\nreliure --version\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreatwizard%2Freliure","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreatwizard%2Freliure","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreatwizard%2Freliure/lists"}