Skip to content

Sigil-Ebook/Sigil

Repository files navigation

Sigil

Sigil is a free, open source, multi-platform ebook editor that uses Qt (and QtWebEngine). It is designed to edit books in ePub format (both ePub 2 and ePub 3).

Links

Issue Tracker

Please do not use the issue tracker to ask questions or suggest new features. Both of the main developers of Sigil monitor the Sigil Forum at https://www.mobileread.com/forums. All questions and feature requests should be directed there so that other interested users can help or comment.

Issue tracking is intended for discussion around issues with the code. It is also intended for actual bug tracking.

Feature requests opened on the issue tracker will be closed.

Linux Build and Install

Starting with Sigil 2.0.2, the default cmake configuration is to build with Qt6. For a while, the latest versions of Sigil can still be built with Qt5 by passing the -DUSE_QT5=1 directive to cmake for the intial configuration.

For newer Linux systems like Ubuntu 23.04 (and its derivitives), or Arch Linux, or Debian Trixie or Unstable, you should be able to compile Sigil using repo-provided dependencies. Instructions for doing so can be found in:

docs/Building_on_Linux.md

The Qt6 build documentation strives to provide both Debian- and Arch-based package names.

For older Linux systems whose software repositories do not provide Qt6.2.3 (or higher), the detailed instructions for building/installing Sigil with Qt5 can be found in:

docs/Building_on_Linux_older.md

An up-to-date version of Sigil is available via flatpak on Flathub. So if your distro can use Flatpak, you can always use Sigil that way if your distro's Sigil package seems to be lagging too far behind.

For Building on Mac OS X

Building using purely XCode is no longer supported on Mac OS X. The easiest way to build Sigil on Mac OS X is to use cmake 3.X and the XCode CommandLineTools.

Also because Sigil now embeds Python 3.11.3, see

docs/Building_A_Relocatable_Python_3.11_Framework_on_MacOSX.txt

for detailed instructions on how to build a fully relocatable Python 3.11.3 framework before building Sigil.

For official releases Sigil uses Qt6.6.2 plus official local patches see:

docs/Building_Qt6_From_Source_on_MacOSX.txt

Sigil master now supports building with Qt-5.10.X through to Qt-6.6.2. For older Qt5 see:

docs/Building_Qt5_From_Source_on_MacOSX.txt

And finally to build Sigil itself see:

docs/Building_Sigil_On_MacOSX_With_Qt6.txt

and for building Sigil under the older Qt5 see:

docs/Building_Sigil_On_MacOSX_With_Qt5.txt

For Installing/Building on Windows

Sigil currently provides a Windows installer for x64 and will work on Windows 10 (1809) or newer.

The latest Sigil versions are also typically available via the winget (Windows 10+), Chocolatey (Windows 10+), and Npackd Windows package managers. There are no "scary" Microsoft warnings about unknown publishers if you install Sigil via one of these package managers.

To build Sigil on Windows yourself, see:

docs/Building_Sigil_on_Windows_with_Qt6.md.

License

Sigil is licensed under the GPLv3. The complete license is located in COPYING.txt.

Note that libraries and components Sigil used and bundles may use a different license (that is compatible with the GPLv3) from Sigil. See the specific component for their respective license. The source code from these projects can be found under Sigil/3rdparty unless otherwise indicated.
Please see their respective folders for complete license information.

Currently these projects include:

  • Hunspell 1.7.2 - https://github.com/hunspell/hunspell
  • MiniZip version 1.1 (plus some security changes)
  • Perl-compatible Regular Expression Library 2 (pcre2 version 10.42)
  • ZLib Data Compression Library (zlib 1.3.1)
  • jQuery-3.6.4 (src/Resource_Files/javascript/jquery-3.6.4.min.js)
  • jQuery.ScrollTo-2.1.2 (src/Resource_Files/javascript/jquery.scrollTo-2.1.2.min.js)
  • MathJax.js Version 3.2.X [required minimum is 3.2.2]: (src/Resource_Files/polyfills)

In addtion, Sigil uses the following other packages that have been specifically modified for use inside Sigil:

  • Beautiful Soup 4 (src/Resource_Files/plugin_launchers/sigil_bs4)
  • Sigil-gumbo based on Google's Gumbo Parser (internal/gumbo)

Sigil in Action

Sigil Sigil Main Window

Sigil Dark Mode Dark Mode

Generate TOC Generate ToC

Plugins Python3 Plugins

Edit Metadata Edit Metadata

Reports Run Reports

Checkpoint Compare Detect Changes

Preview Inspector Preview's Inspector

Custom Layout Customize Your Layout

Validation Validate EPUB, CSS, XHTML, etc.

PageEdit Companion Program Interface to PageEdit Visual XHtml Editor

Package Versions of Sigil

Packaging status