A Digital Publishing Framework from Getty Publications
There are two ways to get started using this template for your own projects. If
you are using the quire-cli, this
template is what you will see after running the
quire new command in a
To start development on your own project, navigate into your project directory
quire preview to see changes locally, and
quire build output static
quire pdf and
quire epub commands are also available if you are
generating other formats for your publication.
Alternatively, you can clone this repository and begin using it directly. In
that case you will probably want to "flatten" the starter kit and it's
accompanying theme into a single repository so you can keep track of your work
in your own Git repository. You only need to follow these steps if you are not
quire command-line tool (it will take care of that for you).
- Clone the kit and its theme submodule:
git clone --recursive https://github.com/gettypubs/quire-starter.git
- Change into the kit directory and remove the submodule from the repo's tree:
git rm --cached themes/quire-starter-theme
- Remove the
- Add the contents of the theme directory to the repo and commit them:
git add themes/quire-starter-theme
- Make sure you have a new remote set up to push changes to as you make them.
Quire is built on top of Hugo, so even without the Quire CLI tool you can still
preview or build your project the same as you would in any other Hugo website
hugo server, etc.). In order to see any changes you've made to the theme
files however, you will also need to run Webpack in the
themes/quire-starter-theme subfolder (make sure to install the necessary
dependencies there first!). To simulate the
quire preview experience you will
need to run
hugo server in the project root and
./node_modules/.bin/webpack --watch in the
At some point you will probably want to publish what you have built so that it can be shared with the wider world. Quire currently supports two methods of deployment: Netlify and Github Pages. Both of these services are fast, free, and fairly easy to setup.
Deploying to Netlify
Assuming you have created a repository for this project on GitHub, sign up or log in to Netlify using your GitHub account.
- Click the big button labeled new site from Git
- Select your repository
- Configure the basic build settings: choose appropriate branch (
- You can set the default build command to
hugoand the publish directory to
public/, but this is not necessare since the
netlify.tomlfile has all the information pre-configured.
- Netlify will auto-generate a site URL for you, or you can set it yourself.
The default example uses
http://quire-demo.netlify.com. Set this as your
config.build.yml, and set
- Now, every time you push up a commit to
masteron GitHub, Netlify will automatically rebuild your site using the settings in
netlify.toml. Pretty cool!
Deploying to GitHub Pages
If you don't need all the features of Netlify, Quire has limited support for
GitHub pages as well, but there are a few caveats. Unlike Netlify, GitHub Pages
does not support continuous deployment for Hugo/Quire websites. This means you
will need to manually deploy the site by running a script provided in
bin/deploy.sh in the project folder.
config.build.yml, comment out the Netlify lines and uncomment the GH Pages
baseURL will need to be in the format that GitHub Pages expects
(https://yourusername.github.io/projectname for most sites). Setting
canonifyURLs: true will help to avoid broken links.
Finally, you will need to remove the
public/ directory from your
file so that you can check built files into version control.
At this point you can run
bin/deploy.sh and everything will be pushed up to
GitHub on the
gh-pages branch. It may take a few moments for everything to
become visible online.
If you get git errors when deploying because of upstream changes, you can always
gh-pages branch on GitHub and re-run the deploy script.
Any web server capable of hosting static files will work (S3, FTP server, etc.),
but you will likely need to customize the values in
config.build.yml to suit