Quire

About Quire

Developed by Getty, Quire is a digital publishing tool that can create dynamic publications in a variety of formats, including web, print, and e-book. Quire is an ideal tool for publishing beautiful, scholarly digital books optimized for visual imagery and designed to ensure publication content is widely accessible and stable.

Quire is open source and free to use. View Quire's 3-clause BSD open source license.

Please note: Quire v1 is currently in a pre-release phase. Testing and improvements are ongoing.

Quire books feature:

Page-level citation
Footnotes
Bibliographies
Figure images and image groups
Image layers and deep linking
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, helpful resources, and information about how to get involved with the community.

Check out publications from the Quire community 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.

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.

Quire Repositories

There are three Quire repositories hosted on GitHub:

quire: Quire’s primary repository, with the command-line interface and 11ty template packages
quire-starter-default: The default starter content for a Quire project
quire-docs: Quire website and documentation.

Installation and Usage for Quire

macOS

Download and install the LTS version of Node.js: https://nodejs.org/en/download/.
Install Quire with npm install --global @thegetty/quire-cli
If you receive an error message that says "Error: EACCES: permission denied," run sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}. Then try step 2 again.
Confirm installation with quire --version. You should see a version number that begins with a 1. If you receive the message "command not found" this means installation was unsuccessful.
Vist the Get Started section of the documentation to begin a new Quire project.

Windows

Download and install Git for Windows: https://gitforwindows.org/.
Download and install the LTS version of Node.js: https://nodejs.org/en/download/.
In PowerShell (Admin) install Quire with npm install --global @thegetty/quire-cli
Once Quire has been installed, change your PowerShell permissions settings with Set-ExecutionPolicy -ExecutionPolicy Unrestricted.
Confirm installation with quire --version. You should see a version number that begins with a 1. If you receive the message "command not found" this means installation was unsuccessful.
Vist the Get Started section of the documentation to begin a new Quire project.

Dependencies

Quire is centered around the static-site generator Eleventy. The Quire command-line interface is written in JavaScript and requires Node.js LTS to run.

Either PrinceXML or Paged.js can be used for PDF generation.

Quire Commands

Option	Result
`-V, --version`	Output the version number
`-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
`build`	Run the build command to generate the html site files
`pdf`	Output Quire project in PDF format (must run `quire build` first)
`epub`	Output Quire project in EPUB format (must run `quire build` first)
`clean`	Remove old `build` outputs

For more information about these commands please see the Quire Commands section of our documentation.

Contributing to Quire

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

Volunteer to do some translation

Write an Article

Share your article idea

Develop a New Feature or Theme

Post your feature idea

For more information visit our complete Contributing Guidelines.

Thank you, Contributors

Thank you to our growing list of contributors who have made Quire what it is and are working on what it will be! They’ve participated in the forum, shared their projects, reported bugs, written/edited documentation, contributed code, and spoken about Quire at conferences.

Special acknowledgment is due to Eric Gardner (@egardner), who served as Digital Publications Developer at Getty from 2014 to 2018, and who conceived and spearheaded the original development of Quire. Thank you, Eric!