This is the reposistory for the Quire website and documentaiton.
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.
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.
Please see the README.md in our main repository wwww.github.com/thegetty/quire to learn more about the technical aspects of Quire, participate in the forum, submit bugs, and more.
You are currently in the quire-docs repository. If you are new to Quire, contributing to this repository is an excellent way to get hands-on experience with the tool because the website and docs were actually built using Quire! We try to keep our site updated continuously for clarity and completeness, but it’s not always easy to keep up with the pace of Quire’s development. We invite you to read our Contributing Guidelines and learn how you can help us develop and refine these resources for the community.
There are four main sections to the website:
- About: Learn about what Quire can do, its history, and the team behind the project.
- Community: Connect with other users, see what others are creating with Quire, learn how to get involved.
- Documentation: Find instructions for how to use Quire from installation to deployment and everything in between. (Currently we have two sets of documentation v1 and v0. The latter is for the legacy version of Quire which will be phased out.)
- Resources: Get started by taking the Quire tutorial and peruse other helpful tools and resources to increase your Quire skillset.
This project was last built with the following software versions:
- Quire 0.20.1
- Node 14.18.1 / npm 6.14.15
- Hugo 0.72
- PrinceXML 14.2
- Pandoc 2.18
While v0.20.1 of the core Quire default theme was used, a number of customizations were made, including:
- Custom cover/homepage layout
- Use of Getty brand fonts
- Shortcodes for glossary definitions and the community showcase display
- Top navigation with section links and a static, always-open sidebar menu on most pages
Within the theme itself, changes were made to the source/css/variables.scss file. Outside of the theme, customizations can be found in the project’s layouts directory and in static/css/custom.css.
© 2022 J. Paul Getty Trust
The text and images of Quire’s documentation is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.