Site Title:
Quire
Table of Contents
About
What Is Quire?
Features & Functionality
Is Quire Right for You?
History
Who We Are
Core Team
Contributors
Community
Get Involved
Answer Forum Questions
Share Your Work
Present Your Project
Organize an Event
Submit or Fix a Bug
Edit Documentation
Write a Recipe
Test Documentation
Become an Ambassador
Community Showcase
News & Events
Upcoming Events
News
Past Events
Forum
Docs v0
Docs v1
Key Changes in Version 1
Content Directory
YAML Files
Config.yaml
Page YAML
Subsection Landing Pages
Shortcodes
Preview URL
CLI Commands
Quire Basics Tutorial
Getting Started
1. Understand the Command-Line Shell
2. Install Quire
3. Create a New Project
4. Preview Your Project
5. Work in a Text Editor
6. Enter Publication Metadata
7. Edit Content
8. Add Images
9. Customize Styles
10. Output Your Project
Congratulations! Now What?
Implementation Considerations
Licensing
Technology Requirements
Skill Requirements
Affiliated Costs
Content Compatibility
Versioning
For Developers
Repositories
Configuration
Publication API
Shortcodes API
Install or Update
Install Quire v1 (macOS)
Install Quire v1 (Windows)
Update Quire
Update an Existing Project
Re-Install Legacy Versions of Quire
Uninstall Quire
Get Started
Start a New Project
Copy an Existing Project
Files for Content Creators and Editors
Files for Developers
Create a Publication Outline
Add Text and Images
Preview and Edit a Project
Quire Commands
Start and Preview Projects
Output Files
Get Help
Not Yet Implemented
Helpful Non-Quire commands
YAML & Markdown
YAML Basics
Markdown Basics
Markdown Output configuration
Markdown Special Cases
Markdown Resources
Microsoft Word to Markdown Conversion
Metadata & Configuration
Adjust the Default Publication Settings in config.yaml File
Add and Edit Important Metadata in publication.yaml File
Page Types & Structure
Page YAML
Define Page Types
Create Sub-sections
Organize Pages in the Right Order
Create Publication Cover Page
Hide/Show Pages
Table of Contents & Sidebar Menu
Table of Contents
Sidebar Menu
Page Content
Start with Page YAML
Format Text Content with Markdown
Use Shortcodes to Add Features
Use HTML to Add Styles
Apply Different Types of Links
Accordion Sections
Wrap Content in the Accordion Shortcode
Copy Links to Accordion Sections
Customize Accordion Link Names
Set an Accordion to Be Open by Default
Add Accordion Global Controls
Configure the Accordion Shortcodes
Figure Images
Include Image Files in Your Publication
Create a figures.yaml File for Figure Image Metadata
Insert Figure Images with {% figure %} Shortcode
Style Figure Images
Create and Style Figure Groups with the {% figuregroup %} Shortcode
Add Video Figures
Add Soundcloud Files
Add Tables
Figure Images: Deep Zoom with IIIF
Create a Zooming Image
Preview and Build a Project with Zooming Images
Improve Performance
Add Existing External IIIF Images
Figures Images: Sequences & Rotations
Prepare the Sequence Image Files
Write the Figure YAML
Display the Image in Your Project
Citations & Bibliographies
Capture Bibliographic Information in YAML
Add In-text Citations
Display a Bibliography
Collection Catalogues
Creating an
objects.yaml
File
Create Object Pages
Generate Object Grids
Advanced Options for Filtering Object Grids
Copyright & About Pages
Contributors
Add Contributors to Your Project
Format Contributors on Your Cover
Display and Format Contributors in Page Headers
Style Customization
Basic Customization
Moderate Customizations
Advanced Customizations
Font Customization
Customize Fonts
Add a New Font
Output Your Project
Site Output
E-Book Output
PDF/Print Output
Deploy Your Project
Basic Deploy
Netlify
GitHub Pages
Troubleshooting
Installation
Quire Commands
Other Issues
Resources
Videos & Articles
Webinars & Demos
Presentations
How-To Guides
Articles
Technical Resources
Command Line
GitHub
HTML & CSS
Eleventy
IIIF
Markdown
Netlify
PDFs and PrinceXML
PDFs and Paged.js
Static Site Generation
Text Editors
YAML
Quire Cheatsheet
Design Guide
Markdown
YAML
Shortcodes
Pre- & Post-Publication Opportunities
Pre-Publication
Post-Publication
Sample Quire Workflow
Project Roles
Pre-transmittal
Transmittal & First Pages
Second Pages
Final Pages
Launch
Recipes
Accessibility Principles
Glossary
GitHub
Host Your Project’s Code on GitHub
Clone an Existing Project from GitHub
Manage Project Changes on GitHub
Collaborate with Others Using GitHub
Manage Third Party Assets with GitHub
Quire Workshop
About Quire
Quire Benefits & Challenges
About this Workshop
Before Getting Started
Part 1. Basic Concepts
Part 2. Basic Concepts In Action
Part 3. Going Deeper: YAML
Part 4. Going Deeper: Images
Part 5. Going Deeper: Shortcodes
Part 6. Going Deeper: Customization
Next Steps
Advanced Quire
Get Started
GitHub
Skip to Main Content
About
Community
Docs v0
Docs v1
Resources
Get Started
GitHub
Search
Table of Contents
2/73
About
What Is Quire?
Learn what Quire is, how it works, and whether it’s right for you
History
View a timeline of key milestones in Quire’s development
Who We Are
Meet Quire’s core team and contributors
Close search window
Search
|
words