Developed by Getty, Quire is a new, multiformat publishing tool available for immediate access and use. Quire is in a limited beta, © J. Paul Getty Trust, and not yet released as open-source software. For a free license to use Quire, please complete this form.
Quire is an ideal tool for anyone seeking to publish a beautiful, scholarly digital book optimized for visual imagery and designed to ensure its content is widely accessible and stable.
Quire books feature:
- Page-level citation
- Footnotes
- Bibliographies
- Figure images and image groups
- Zooming images and maps
- Video and audio embeds
- Dynamic tables of contents and menus
- Full-text search
- Responsive web design
- Web accessibility and SEO optimized
- Outputs to web, PDF, and EPUB formats
To learn more about Quire, please visit our website which includes documentation, a showcase of Quire publications, helpful tutorials & guides, and more information about Quire and how to get involved with the community.
Check out the demo site and some of Getty’s books developed with Quire.
If you’re considering using Quire for the first time, please be sure to visit our Implementation Considerations. If you’re a developer, please also visit the For Developers section of our documentation.
We encourage you to sign up for a free GitHub account to access the Quire Community Forum. You can utilize the forum to ask and answer questions, share ideas, provide feedback, and assist your fellow Quire users. Subscribe to our newsletter for the latest news and events, new feature updates, and highlights from our community.
This is the mono-repository for Quire. It contains:
- packages/cli: the quire command-line interface for Quire
- starters/default: default starter content used as placeholder content when starting a new Quire project
- themes/default: default theme designed to broadly cover a full range of use-cases and to demonstrate the range of the Quire content model
- Install Apple’s Xcode with:
xcode-select --install - Install the LTS version of Node.js: https://nodejs.org
- Install Quire with:
npm install --global \@thegetty/quire-cli - Confirm by pulling up a list of Quire commands:
quire --help
- Install Git for Windows: https://gitforwindows.org/
- Install the LTS version of Node.js: https://nodejs.org
- Install Windows Build Tools with:
npm install --g --production windows-build-tools - Install Quire with:
npm install --global \@thegetty/quire-cli - Confirm by pulling up a list of Quire commands:
quire --help
For full installation instructions, and information about updating and uninstalling Quire, please see our documentation.
Quire is centered around the static-site generator Hugo. The Quire command-line interface is written in Javascript and requires Node.js LTS to run.
In order to produce multiple formats using Quire, you must first install the following support software:
- PrinceXML for PDF generation
- Pandoc for EPUBs and MOBIs
- Kindle Previewer for MOBIs
| Option | Result |
|---|---|
| -V, --version | Output the version number |
| -v, --verbose | Log verbose output |
| -f, --file | Add Filename and optional new filepath |
| -e, --env | Add environment variable |
| -h, --help | Output usage information |
| Command | Result |
|---|---|
| new <projectName> | Create a new Quire project in the current directory. |
| preview | Run the preview server in the current directory |
| install | Install this project's theme dependencies |
| site | Run the build command in the current directory |
| Generate a PDF version of the current project | |
| process | Run a Quire process. Currently only supports the "--iiif" option |
| epub | Generate an EPUB version of the current project |
| mobi | Generate an MOBI version of the current project |
| template | Download templates to customize your file output (only for EPUB) |
| debug | Development use only - log info about current project |
For more information about these commands please see the Quire Commands section of our documentation.
There are many ways to contribute. No matter what level of experience you have, we welcome all contributions, big and small.
The first step to any contribution is to post a new issue or comment on an existing issue on our issue tracker. Please label your issues to the best of your abilities.
Possible contributions include:
Fix or Report a Bug
Improve Documentation
Translate the Documentation
Write an Article
Develop a New Feature or Theme
For more information visit our complete Contributing Guidelines.
Copyright © 2021, J Paul Getty Trust.