chrkaatz / quire

Documentation for Quire, a multiformat publishing framework

Quire (Alpha)

Quire is a modern, multiformat publishing framework designed to create books as authoritative and enduring as print, and as vibrant and feature-rich as the web, from a single set of plain text files. All without ever signing-up for an account, paying a fee, or setting up and maintaining a complicated server.

Quire books are scholarly, visual, and built for discoverability and longevity. They 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

View some of the books developed with early versions of Quire.

Getting Started

Follow the step-by-step introduction in the Getting Started chapter of the guide to:

1. Install Quire and its dependencies
2. Create and preview a new starter project
3. Customize the metadata, content, and styles to make it your own
4. Output your publication

[Quire is currently in closed development. To request access, please fill out our Quire Beta Request form. Or for more information, contact Greg Albers at [e-mail].]

Guide & Documentation

• Tutorial: Quire Basics
• Guide
  • Install and Uninstall
  • Getting Started
  • Fundamentals: YAML & Markdown
  • Metadata & Configuration
  • Pages
  • Collection Catalogues
  • Figure Images
  • Zooming Images & Maps
  • Citations & Bibliographies
  • Copyright & About Pages
  • Contributors
  • Style Customization
  • Fonts Customization
  • Multiformat Output
• API/Docs
  • YAML
  • Shortcodes
  • Dependency Guide
• Resources
  • Quire Cheatsheet
  • Default Style Guide
  • Quire CLI Instructions
  • GitHub for Quire
  • Sample publication.yml file
  • Accessibility Principals
  • Hugo Documentation
• About

(Note: entries in italics are placeholder stubs.)

• Links
  • Quire Workshop Syllabi & Agendas
  • Hugo Documentation
  • “Quire: A New Publishing Tool”
  • “Why Static Site Generators Are the Next Big Thing”
  • “An Editor’s View of Digital Publishing”

Technical

Quire is centered around Hugo, and uses PrinceXML for PDF generation and pe-epub for EPUBs.

Quire consists of four primary repositories, all of which but this one are closed during development.

• quire (documentation and homepage)
• quire-cli
• quire-starter
• quire-starter-theme

To request access, please fill out our Quire Beta Request form. Or for more information, contact Greg Albers at [e-mail].

License

© J. Paul Getty Trust

This documentation is licensed under a Creative Commons Attribution 4.0 International License.